buildValue

Returns a syntactically valid representation of a member list, dimension member, or function.

When specifying dimension values, you must follow the same syntax rules for specifying member lists, members, and functions that the user interface requires. Using buildValue enables you to build valid dimension values without having to perform tasks such as concatenating delimiters and required special characters.

For example, if you pass a member list name and a top member, buildValue returns a dimension value that includes the braces ( {} ) required to specify member lists and the period ( . ) that delimits the labels of the top member and the member list.

Tip:

You can use the return value to specify dimension values with AttrAll, AttrDim, and HFMwMbrSelDim.Attr.

Syntax

<HFMwMbrSel>.buildValue (lEnumType, bstrMajor, bstrMinor)

Argument

Description

lEnumType

A flag that indicates the type of dimension value to return. Pass one of the HFMConstants type library constants listed in Dimension Value Type Constants.

Input argument. Long subtype.

bstrMajor

The label of the member list, dimension member, or function.

Input argument. String subtype.

bstrMinor

Pass one of the following values:

  • For dimension members, the label of the parent member, or a blank string if no parent is needed.

  • For member lists, the label of the top member, or a blank string if you are not specifying a top member.

  • For functions, the value for the parameter, or a blank string if there is no parameter.

Input argument. String subtype.

Return Value

Returns a string that contains the dimension value.

Example

The following example returns the string “{Quarter1.[Hierarchy]}”.

Dim cMbrSel, vRet
Set cMbrSel = Server.CreateObject("Hyperion.HFMwMbrSel")
'g_cSession is an HFMwSession object reference
cMbrSel.SetWebSession g_cSession
vRet = cMbrSel.buildValue(WEBOM_MBRSEL_VALTYPE_LIST, "[Hierarchy]", _ 
  "Quarter1")