IPartitionCollection methods

Table 131. Multi-tenant Maintenance IPartitionCollection interface methods
Method syntax	Description
LOGICAL CanFindGroup ( pcGroup AS CHARACTER , pcTable AS CHARACTER , pcField AS CHARACTER , pcIndex AS CHARACTER , pcCollation AS CHARACTER¹ )	Returns TRUE if there is a partition object in the collection for the tenant group and an appropriate combination of table, field, and index, each specified by name in the respective parameters to identify a single partition, using a blank value as needed.²
LOGICAL CanFindTenant ( pcTenant AS CHARACTER , pcTable AS CHARACTER , pcField AS CHARACTER , pcIndex AS CHARACTER , pcCollation AS CHARACTER³ )	Returns TRUE if there is a partition object in the collection for the tenant and an appropriate combination of table, field, and index, each specified by name in the respective parameters to identify a single partition, using a blank value as needed.⁴
LOGICAL Contains ( partition AS IPartition )	Returns TRUE if the partition object referenced by partition is in the collection.
IPartition FindGroup ( pcGroup AS CHARACTER , pcTable AS CHARACTER , pcField AS CHARACTER , pcIndex AS CHARACTER , pcCollation AS CHARACTER⁵ )	Returns the partition object from the collection for the tenant group and an appropriate combination of table, field, and index, each specified by name in the respective parameters, using a blank value as needed.⁶ Returns the Unknown value (?) if the partition object is not found.
IPartition FindTenant ( pcTenant AS CHARACTER , pcTable AS CHARACTER , pcField AS CHARACTER , pcIndex AS CHARACTER , pcCollation AS CHARACTER⁷ )	Returns the partition object from the collection for the tenant and an appropriate combination of table, field, and index, each specified by name in the respective parameters to identify a single partition, using a blank value as needed.⁸ Returns the Unknown value (?) if the partition object is not found.

¹ Reserved for future use. In the current release, set to the empty string ("").

² For instance, to identify the partition for a table and a tenant, set pcTenant to the name of the tenant (such as "EastSports"), then set pcTable to the name of the table (such as "Customer") and set pcField and pcIndex to the empty string (""); to identify the partition for a field in the table, set pcField to the name of a field in the specified table (such as "CustNum") and leave pcIndex set to the empty string.

³ Reserved for future use. In the current release, set to the empty string ("").

⁴ For instance, to identify the partition for a table and a tenant, set pcTenant to the name of the tenant (such as "EastSports"), then set pcTable to the name of the table (such as "Customer") and set pcField and pcIndex to the empty string (""); to identify the partition for a field in the table, set pcField to the name of a field in the specified table (such as "CustNum") and leave pcIndex set to the empty string.

⁵ Reserved for future use. In the current release, set to the empty string ("").

⁶ For instance, to identify the partition for a table and a tenant, set pcTenant to the name of the tenant (such as "EastSports"), then set pcTable to the name of the table (such as "Customer") and set pcField and pcIndex to the empty string (""); to identify the partition for a field in the table, set pcField to the name of a field in the specified table (such as "CustNum") and leave pcIndex set to the empty string.

⁷ Reserved for future use. In the current release, set to the empty string ("").

⁸ For instance, to identify the partition for a table and a tenant, set pcTenant to the name of the tenant (such as "EastSports"), then set pcTable to the name of the table (such as "Customer") and set pcField and pcIndex to the empty string (""); to identify the partition for a field in the table, set pcField to the name of a field in the specified table (such as "CustNum") and leave pcIndex set to the empty string.