CreateDataIndexList

Creates an HsvMDIndexList object based upon the items in an HsvMDDataBufferLite object.

CreateDataIndexList takes arguments for the Financial Management dimensions; these arguments determine which items in the HsvMDDataBufferLite object are added to the HsvMDIndexList object. For each dimension, pass one of the following:

A member ID. Passing a member ID means that only items for this member will be added to the HsvMDIndexList object.
MEMBERALL constant. Passing MEMBERALL means that all items containing the dimension member will be added to the HsvMDIndexList object.
MEMBERNOTUSED constant. Passing MEMBERNOTUSED means that only those items containing MEMBERNOTUSED for the dimension member will be added to the HsvMDIndexList object.
MEMBERANYONE constant. Passing MEMBERANYONE means that if the HsvMDDataBufferLite object contains more than one item where all other dimension members are the same, only one instance will be added to the HsvMDIndexList object.
Tip:
These constants are in the HFMConstants type library. For more information, see Dimension Member Constants.

Syntax

<HsvMDDataBufferLite>.CreateDataIndexList lScenario As Long, lYear As Long, lPeriod As Long, lView As Long, lEntity As Long, lParent As Long, lValue As Long, lAccount As Long, lICP As Long, lCustom1 As Long, lCustom2 As Long, lCustom3 As Long, lCustom4 As Long, ppIMDIndexListUnk As Unknown

Argument	Description
lScenario	Long (ByVal). The member ID of the Scenario dimension member, or one of the constants listed above in the method’s description.
lYear	Long (ByVal). The member ID of the Year dimension member, or one of the constants listed above in the method’s description.
lPeriod	Long (ByVal). The member ID of the Period dimension member, or one of the constants listed above in the method’s description.
lView	Long (ByVal). The member ID of the View dimension member, or one of the constants listed above in the method’s description.
lEntity	Long (ByVal). The member ID of the Entity dimension member, or one of the constants listed above in the method’s description.
lParent	Long (ByVal). The member ID of the parent of the lEntity argument’s entity, or one of the constants listed above in the method’s description.
lValue	Long (ByVal). Long (ByVal). The member ID of the Value dimension member, or one of the constants listed above in the method’s description.
lAccount	Long (ByVal). Long (ByVal). The member ID of the Account dimension member, or one of the constants listed above in the method’s description.
lICP	Long (ByVal). Long (ByVal). The member ID of the Intercompany Partner dimension member, or one of the constants listed above in the method’s description.
lCustom1	Long (ByVal). Long (ByVal). The member ID of the Custom 1 dimension member, or one of the constants listed above in the method’s description.
lCustom2	Long (ByVal). The member ID of the Custom 2 dimension member, or one of the constants listed above in the method’s description.
lCustom3	Long (ByVal). The member ID of the Custom 3 dimension member, or one of the constants listed above in the method’s description.
lCustom4	Long (ByVal). The member ID of the Custom 4 dimension member, or one of the constants listed above in the method’s description.
ppIMDIndexListUnk	HsvMDIndexList object. Returns an HsvMDIndexList object containing the items in the HsvMDDataBufferLite object that match the criteria specified in the other arguments.

Example

The following example creates an HsvMDIndexList object that contains all of the items in the HsvMDDataBufferLite object. The example then loops through the HsvMDIndexList object: GetNumItems returns the number of items in the object, and GetItem is called for each item. After the call to GetItem, you could operate upon the item’s dimension members by replacing the ellipsis (...) with code.

Dim lScen As Long, lYear As Long, lPer As Long, lView As Long
Dim lEnt As Long, lPar As Long, lVal As Long, lAcct As Long
Dim lICP As Long, lCust1 As Long, lCust2 As Long, lCust3 As Long
Dim lCust4 As Long, lItems As Long, lItem As Long
m_cMDBufferLite.CreateDataIndexList MEMBERALL, MEMBERALL, _ 
MEMBERALL, MEMBERALL, MEMBERALL, MEMBERALL, MEMBERALL, _ 
MEMBERALL, MEMBERALL, MEMBERALL, MEMBERALL, MEMBERALL, _ 
MEMBERALL, m_cMDIndexList
m_cMDIndexList.GetNumItems lItems - 1
For lItem = 0 To lItems
  m_cMDIndexList.GetItem lItem, lScen, lYear, lPer, lView, _ 
  lEnt, lPar, lVal, lAcct, lICP, lCust1, lCust2, lCust3, _ 
  lCust4
  … 'Insert code here.
Next lItem