Product Documentation

c-treeACE V10.0 Update Guide

Previous Topic

Next Topic

CTTable.PartAdminByName

Performs an administrative partition operation on the partition specified by partition name.

Declaration

COUNT PartAdminByName( String partname, CTPART_MODE_E partmode );

Description

PartAdminByName() manages the partitions for a table.

  • partname [in] - partition name.
  • partmode [in] - partition operation mode. partmode is one of of the CTPART_MODE_E enums:

     

    PURGE

    delete a partition

     

    ADD

    add a partition

     

    ARCHIVE

    archive a partition

     

    BASE

    modify the lower limit partition number value

     

    ACTIVATE

    activate an archived partition

     

    STATUS

    return the partition status in partstatus

Return Values

CTDBRET_NOERROR is returned if no error.

If CTPART_MODE_E.STATUS is passed as a partition mode, then one of the following partstatus values is returned:

pmSTATUSnone

0

Partition member does not exist.

pmSTATUSexst

1

Partition member is active.

pmSTATUSopnd

2

Partition member is active and currently open.

pmSTATUSarhv

3

Partition member is archived.

pmSTATUSpurg

4

Partition member was purged.

pmSTATUSparc

19

Partition member is pending archive.

pmSTATUSppnd

20

Partition member is pending purge.

See Also

CTTable.PartAdminByKey(), CTTable.PartAdminByNumber()

TOCIndex