HypOtlGetMemberInfo

Data source types: Essbase

Description

HypOtlGetMemberInfo() returns the following information related to a member selection: member comment, formula, UDA, attribute, etcetera.

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: For future use. Currently the active sheet is used.

vtDimensionName: The name of the dimension. Can be Null; if Null, search for the predicate in the whole outline. Dimension to limit the scope of the query.

vtMemberName: Member name for which information is being queried on.

vtPredicate: Member selection criteria:

1 HYP_COMMENT

2 HYP_FORMULA

3 HYP_UDA

4 HYP_ATTRIBUTE

vtMemberArray: Output that contains the result of the query. Its contents are unknown if the macro fails.

Return Value

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

Example

Declare Function HypOtlGetMemberInfo  Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtMemberName As Variant, ByVal vtPredicate As Variant, ByRef vtMemberArray As Variant) As Long

Sub 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 
Else 
MsgBox ("Return Value = " + vtRet) 
End If
End Sub