EsbPartitionGetList

Description

EsbPartitionGetList() eturns a list of the partition definitions in which the currently selected database participates.

Syntax

EsbPartitionGetList (hCtx, SelectRegion, pusCount)
ByVal hCtx         As Long
      SelectRegion As ESB_PARTSLCT_T 
      pusCount     As Integer

Parameters

hCtx Essbase API context handle.
SelectRegion Criteria to select partitions.
pusCount Items of partitions returned.

Return Value

Returns zero if successful; error code if unsuccessful.

Example

Public Sub ESB_PartitionGetList()

   Dim SelectPartition As ESB_PARTSLCT_T
   Dim Partition As ESB_PART_INFO_T
   Dim Items As Integer
   Dim i As Integer
   
   SelectPartition.OperationTypes = ESB_PARTITION_OP_ALL
   SelectPartition.DirectionTypes = ESB_PARTITION_DATA_BOTH
   SelectPartition.MetaDirectionTypes = ESB_PARTITION_META_BOTH

   sts = EsbPartitionGetList(hCtx, SelectPartition, Items)
   
   If sts = 0 And Items > 0 Then
      For i = 1 To Items
         sts = EsbGetNextItem(hCtx, ESB_PART_INFO_TYPE, Partition)

	   '*****************************************
         '* Get information in ESB_PART_INFO_T here
	   '*****************************************

      Next i
   End If
  
End Sub

See Also

Constant and Structure Definitions for Partitions
EsbPartitionApplyOtlChangeFile()
EsbPartitionGetAreaCellCount()
EsbPartitionGetOtlChanges()
EsbPartitionGetReplCells()
EsbPartitionPurgeOtlChangeFile()
EsbPartitionPutReplCells()
EsbPartitionResetOtlChangeTime()