GetCellDescriptions

Returns the cell text descriptions of one or more cells.

GetCellDescriptions takes arrays of dimension member IDs as arguments; these arrays must contain identical numbers of elements. The elements of these arrays have a one-to-one correspondence to the elements of the array that is returned; the first elements of the member ID arrays define the first cell to be returned, the second elements of the member ID arrays define the second cell to be returned, and so on.

Syntax

<HsvData>.GetCellDescriptions varlScenario, varlYear, varlPeriod, varlEntity, varlParent, varlValue, varlAccount, varlICP, varlCustom1, varlCustom2, varlCustom3, varlCustom4, pvarbstrCellText

Argument	Description
varlScenario	Long array (ByVal). The member IDs of the cells' Scenario dimension members.
varlYear	Long array (ByVal). The member IDs of the cells' Year dimension members.
varlPeriod	Long array (ByVal). The member IDs of the cells' Period dimension members.
varlEntity	Long array (ByVal). The member IDs of the cells' Entity dimension members.
varlParent	Long array (ByVal). The member IDs of the parents of the varalEntity argument's entities.
varlValue	Long array (ByVal). The member IDs of the cells' Value dimension members.
varlAccount	Long array (ByVal). The member IDs of the cells' Account dimension members.
varlICP	Long array (ByVal). The member IDs of the cells' Intercompany Partner dimension members.
varlCustom1	Long array (ByVal). The member IDs of the cells' Custom 1 dimension members.
varlCustom2	Long array (ByVal). The member IDs of the cells' Custom 2 dimension members.
varlCustom3	Long array (ByVal). The member IDs of the cells' Custom 3 dimension members.
varlCustom4	Long array (ByVal). The member IDs of the cells' Custom 4 dimension members.
pvarbstrCellText	Variant array. Returns cell text descriptions of the cells identified by the other arguments. The array items are returned as a String subtype.

Example

This example places the cell text of cells into a ListBox control. The example assumes that the cells’ member ID arguments are passed from another procedure. GetCellDescriptions puts the array of cell text descriptions for the cells into the saCellText variable. The example then loops through this array, putting the array elements into the lstDesc ListBox.

Dim saCellText, iHighIndex As Integer, iLowIndex As Integer
Set m_cData = m_cSession.Data
m_cData.GetCellDescriptions laScen, laYear, laPer, laEnt, _ 
laPar, laVal,laAcct, laICP, laCust1, laCust2, laCust3, _ 
laCust4, saCellText
iHighIndex = UBound(saCellText)
For iLowIndex = LBound(saCellText) To iHighIndex
  lstDesc.AddItem saCellText(iLowIndex)
Next iLowIndex

For an example of how to configure the member ID arrays passed as arguments, see the example for GetCells, which takes a similar set of arguments.