EnumMembers2

Enumerates the member IDs, labels, descriptions, and number of children of the members in a static or dynamic member list. A flag specifies which of these types of information will be returned.

Note:

You can also return members from a static member list with EnumMembers, which does not require you to pass labels or member IDs of dimension members.

Syntax

<HFMwDimension>.EnumMembers2 (varPOVScenario, varPOVYear, varPOVPeriod, varPOVEntity, varMemberlist, varTopMember, lStartingIndex, lMaxMembers, lFlagsRequestedInfo, pvaravarlMemberIDs, pvaravarlParentIDs, pvaravarbstrMemberLabels, pvaravarbstrDescriptions, pvaravarlNumChildren, pvarlTotalMembersInEnum)

Argument	Description
varPOVScenario	The member ID or label of the Scenario dimension member. Tip: If you are returning members of a static member list, you can pass the HFMConstants type library constant MEMBERNOTUSED to this argument and to the varPOVYear, varPOVPeriod, and varPOVEntity arguments. Input argument.
varPOVYear	The member ID or label of the Year dimension member. Input argument.
varPOVPeriod	The member ID or label of the Period dimension member. Input argument.
varPOVEntity	The member ID or label of the Entity dimension member. Input argument.
varMemberlist	The ID or label of the member list. Note: An ID must be cast as a Long subtype. Input argument.
varTopMember	The member ID or label of the top member in the hierarchy with which to begin enumerating. To start enumerating at the top of the hierarchy, pass either -1 or an empty string. Note: An ID must be cast as a Long subtype. Input argument.
lStartingIndex	The starting index (base 0) within the enumeration for retrieving member information. Input argument. Long subtype.
lMaxMembers	The maximum number of members to return. To return all child members, pass 0. Input argument. Long subtype.
lFlagsRequestedInfo	A bitmask that specifies the type of information to return. Valid values for the bits are represented by the HFMConstants type library constants listed in Metadata Information Constants. Input argument. Long subtype.
pvaravarlMemberIDs	If WEBOM_METADATA_INFO_ID or WEBOM_METADATA_INFO_ALL is included in the lFlagsRequestedInfo argument’s bitmask, this returns an array of member IDs. Input/output argument.
pvaravarlParentIDs	If EnumMembers2 is called for the entity dimension, and WEBOM_METADATA_INFO_ID or WEBOM_METADATA_INFO_ALL is included in the lFlagsRequestedInfo argument’s bitmask, this returns an array of member IDs for the parents of the list’s members. Input/output argument.
pvaravarbstrMemberLabels	If WEBOM_METADATA_INFO_LABEL or WEBOM_METADATA_INFO_ALL is included in the lFlagsRequestedInfo argument’s bitmask, this returns an array of the labels of the list’s members. Input/output argument.
pvaravarbstrDescriptions	If WEBOM_METADATA_INFO_DESCRIPTION or WEBOM_METADATA_INFO_ALL is included in the lFlagsRequestedInfo argument’s bitmask, this returns an array of the descriptions of the list’s members. Input/output argument.
pvaravarlNumChildren	If WEBOM_METADATA_INFO_NUMCHILDREN or WEBOM_METADATA_INFO_ALL is included in the lFlagsRequestedInfo argument’s bitmask, this returns an array indicating the number of child members for each enumerated member. Input/output argument.
pvarlTotalMembersInEnum	Returns the total number of members in the list. Input/output argument.

Return Value

Returns a count of the members returned by this method.