GetListInfo

Returns the ID of the member list that is currently selected for a given dimension, as well as the member ID of the specified top member.

Tip:

To return whether only active Entity members are displayed for Organization by Period applications, use GetOBPInfo.

Syntax

<HsvPOVSelection>.GetListInfo lDim, plListID, plListTopMemberID

Argument

Description

lDim

Long (ByVal). The ID of the dimension. Dimension IDs are represented by the HFMConstants type library constants listed in Dimension ID Constants.

plListID

Long. Returns the ID of the member list.

Tip:

To get a member list name from its ID, use the IHsvTreeInfo method GetMemberListName.

plListTopMemberID

Long. Returns the member ID of the specified top member.

If no top member is specified, the HFMConstants type library constant MEMBERNOTUSED is returned. For information on this constant, see Dimension Member Constants.

Example

The following function returns the name of the member list that is selected on a given dimension’s tab. The name is obtained by passing the list ID to IHsvTreeInfo.GetMemberListName.

Function getListName(lDim As Long) As String
Dim lId As Long, lTopMemId As Long
Dim cTreeInfo As IHsvTreeInfo, sRet As String
'g_cMetadata is a previously set HsvMetadata instance
Set cTreeInfo = g_cMetadata.Dimension(lDim)
'cFormPOV represents an initialized HsvPOVSelection control
cFormPOV.GetListInfo lDim, lId, lTopMemId
cTreeInfo.GetMemberListName lId, sRet
getListName = sRet
End Function