parseValue

Parses a dimension value into its label and type. The method also returns the dimension value’s top member, parent, or parameter, depending upon whether the dimension value a member list, member label, or function.

parseValue also indicates whether the syntax of the specified dimension value is valid. You should always check the return value. If a dimension value does not consist of valid syntax, the information returned in the output parameters may not be valid, since valid syntax is required for accurate parsing.

Syntax

<HFMwMbrSel>.parseValue (bstrValue, pvarbstrMajor, pvarbstrMinor, pvarlEnumType)

Argument

Description

bstrValue

The dimension value.

Input argument. String subtype.

pvarbstrMajor

Returns the label of the member, member list, or function.

Input/output argument.

pvarbstrMinor

Returns one of the following values:

  • For dimension members, the label of the parent member, or a blank string if the dimension value does not contain a parent.

  • For member lists, the label of the top member, or a blank string if the dimension value does not contain a top member.

  • For functions, the value for the parameter, or a blank string if the dimension value does not contain a parameter.

Input/output argument.

pvarlEnumType

Indicates the type of dimension value passed to the bstrValue parameter. Valid values are represented by the HFMConstants type library constants listed in Dimension Value Type Constants.

Input/output argument.

Return Value

Indicates whether the bstrValue parameter contains a valid value. Returns TRUE if the value is valid, FALSE otherwise.

Example

The following snippet returns the member list label [Hierarchy], the top member Quarter1, and the dimension value type of member list.

Dim cMbrSel, vRet, sMajor, sMinor, lType
Set cMbrSel = Server.CreateObject("Hyperion.HFMwMbrSel")
'g_cSession is an HFMwSession object reference
cMbrSel.SetWebSession g_cSession
vRet = cMbrSel.parseValue("{Quarter1.[Hierarchy]}", sMajor, sMinor, _
  lType)