EnumMembersAsXML

Returns an XML string containing the member IDs, labels, descriptions, or number of children of the members in a specified member list. A flag specifies which of these types of information will be returned.

Syntax

<HFMwDimension>.EnumMembersAsXML (varOBPScenario, varOBPYear, varOBPPeriod, varMemberlist, varTopMember, lStartingIndex, lMaxMembers, lFlagsRequestedInfo, pvarbstrXMLDoc, pvarlTotalMembersInEnum)

Argument

Description

varOBPScenario

Pass one of the following:

  • For Organization by Period enumerations, pass the member ID or label of the Scenario dimension member.

  • For non-Organization by Period enumerations, pass -1.

    Note:

    An ID must be cast as a Long subtype.

Input argument.

varOBPYear

Pass one of the following:

  • For Organization by Period enumerations, pass the member ID or label of the Year dimension member.

  • For non-Organization by Period enumerations, pass -1.

    Note:

    An ID must be cast as a Long subtype.

Input argument.

varOBPPeriod

Pass one of the following:

  • For Organization by Period enumerations, pass the member ID or label of the Period dimension member.

  • For non-Organization by Period enumerations, pass -1.

    Note:

    An ID must be cast as a Long subtype.

Input argument.

varMemberlist

Specifies the member list for which members will be enumerated. You can pass either the ID or the name of the member list.

Note:

An ID must be cast as a Long subtype.

Input argument.

varTopMember

Specifies the top member in the hierarchy with which to begin enumerating. You can pass either the member ID or name of the member. 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

Specifies the starting index (base 0) within the enumeration for retrieving member information.

Input argument. Long subtype.

lMaxMembers

Specifies the maximum number of members to return. To return all child members, pass 0.

Input argument. Long subtype.

lFlagsRequestedInfo

Specifies the type of information to return. Valid values are represented by the HFMConstants type library constants listed in Metadata Information Constants. You can pass more than one constant by using Or.

Input argument. Long subtype.

pvarbstrXMLDoc

Returns an XML String containing the requested information. The XML string is described in Dimension Member Enumerations DTD.

Output argument.

pvarlTotalMembersInEnum

Returns the total number of members in the list.

Output argument.

Return Value

Returns the number of members in the XML string that is returned by the pvarbstrXMLDoc argument.