HypOtlGetMemberInfo

Data provider types: Essbase

Description

HypOtlGetMemberInfo() returns the comments, formulas, UDAs, and attributes associated with the selected member selection.

Syntax

HypOtlGetMemberInfo (vtSheetName, vtDimensionName, vtMemberName, vtPredicate, vtMemberArray)

ByVal vtSheetName As Variant

ByVal vtDimensionName As Variant

ByVal vtMemberName As Variant

ByVal vtPredicate As Variant

ByRef vtMemberArray As Variant

Parameters

vtSheetName: The name of worksheet on which to run the function. If vtSheetName is Null or Empty, the active worksheet is used.

vtDimensionName: The dimension of the member. If set to Null, the predicate in the whole outline is searched.

vtMemberName: The member for which to retrieve information. Required; there is no default value.

vtPredicate: Member selection criteria:

• 1 = HYP_COMMENT

• 2 = HYP_FORMULA

• 3 = HYP_UDA

• 4 = HYP_ATTRIBUTE

vtMemberArray: Output parameter; the result of the query.

Return Value

Returns 0 if successful; otherwise returns the appropriate error code.

Example

Declare Function HypOtlGetMemberInfo Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtDimensionName As Variant, ByVal vtMemberName As Variant,  ByVal vtPredicate As Variant, ByRef vtMemberArray As Variant) As Long
Sub Example_HypOtlGetMemberInfo()
	vtRet = HypOtlGetMemberInfo(Empty, "Year", "Jan", HYP_COMMENT, vt) 
If IsArray(vt) Then cbItems = UBound(vt) + 1 
	MsgBox ("Number of elements = " + Str(cbItems)) 
For i = 0 To UBound(vt) 
	MsgBox ("Member = " + vt(i)) 
Next 
MsgBox ("Return Value = " + vtRet) 
End Sub