Returns the label and description of a dimension member. You can call GetDisplayInfo for a member in an application’s default dimension hierarchy or a member in a member list. If you call GetDisplayInfo for the default dimension hierarchy, a Boolean indicating whether the member has child members is also returned.
<IHsvTreeInfo>.GetDisplayInfo lListID, lItemID, lParentID, pbHasChildren, pbstrLabel, pbstrDescLong (ByVal). Identifies either the default dimension hierarchy or a member list. Pass the HFMConstants type library constant MEMBER_LIST_ALL_HIERARCHY to return a member from the default hierarchy, or pass a valid list ID to return a member from a member list. You can get member list IDs with GetMemberListID. For more information, see GetMemberListID. | |
Long (ByVal). The member ID of the dimension member for which you want to return information. | |
Long (ByVal). For hierarchical dimensions such as the Entity dimension, pass the member ID of the parent of the lItemID argument’s dimension member. For non-hierarchical dimensions such as the Scenario dimension, pass the HFMConstants type library constant MEMBERNOTUSED. | |
Boolean. If you pass MEMBER_LIST_ALL_HIERARCHY to the lListID argument, pbHasChildren returns TRUE if the lItemID argument’s member has children, otherwise FALSE. If you pass anything other than MEMBER_LIST_ALL_HIERARCHY to the lListID argument, pbHasChildren always returns FALSE, regardless of whether the lItemID argument’s member has children. | |
String. Returns the label of the lItemID argument’s member. For hierarchical dimensions, the label of the lParentID argument’s member is prefixed to the label of the lItemID argument’s member, with a period delimiting the parent and child labels. | |
String. Returns the description of the lItemID argument’s member. The description is returned in the default language. |
The following example prints the name and description of the California entity to the Immediate window.
Dim cTreeInfo As IHsvTreeInfo, lEnt As Long, lPar As Long
Dim bHasChildren As Boolean, sName As String, sDesc As String
Set cTreeInfo = m_cMetadata.Entities
lEnt = cTreeInfo.GetItemID("California")
lPar = cTreeInfo.GetItemID("UnitedStates")
cTreeInfo.GetDisplayInfo MEMBER_LIST_ALL_HIERARCHY, lEnt, _
lPar, bHasChildren, sName, sDesc
Debug.Print sName & " " & sDesc