Data provider types: Oracle Essbase
Description
HypGetMemberInformation returns the properties of a selected member.
Syntax
HypGetMemberInformation (vtSheetName, vtMemberName, vtPropertyName, vtPropertyValue, vtPropertyValueStrings)
ByVal vtMemberName As Variant
ByVal vtPropertyName As Variant
ByVal vtPropertyValue As Variant
ByRef vtPropertyValueStrings 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.
vtMemberName: The member for which to retrieve information. Required; there is no default value.
vtPropertyName: Input parameter; the name of the property for which information is required. See Table 12-1.
vtPropertyValue: Output parameter; the property array for the member, returned as numerical value from the server.
vtPropertyValueStrings: Output parameter; the property array for the member, returned as string equivalent of numerical value for properties for which numerical values do not make sense.
Return Value
Returns 0 if successful; otherwise, returns the appropriate error code.
Example
Declare Function HypGetMemberInformation Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtMemberName As Variant, ByVal vtPropertyName As Variant, ByRef vtPropertyValue As Variant, ByRef vtPropertyValueStrings As Variant) As Long
Sub Example_HypGetMemberInformation
sts = HypGetMemberInformation("Sheet1", "Jan", HYP_MI_NAME, vtValues, vtPropertyValueString)
End Sub
Table 12-1 Constants for Member Information
| Constants for Member Information |
|---|
| Global Const HYP_MI_NAME = "Name" |
| Global Const HYP_MI_DIM = "Dim" |
| Global Const HYP_MI_LEVEL = "Level" |
| Global Const HYP_MI_GENERATION = "Generation" |
| Global Const HYP_MI_PARENT_MEMBER_NAME = "ParentMbrName" |
| Global Const HYP_MI_CHILD_MEMBER_NAME = "ChildMbrName" |
| Global Const HYP_MI_PREVIOUS_MEMBER_NAME = "PrevMbrName" |
| Global Const HYP_MI_NEXT_MEMBER_NAME = "NextMbrName" |
| Global Const HYP_MI_CONSOLIDATION = "Consolidation" |
| Global Const HYP_MI_IS_TWO_PASS_CAL_MEMBER = "IsTwoPassCalcMbr" |
| Global Const HYP_MI_IS_EXPENSE_MEMBER = "IsExpenseMbr" |
| Global Const HYP_MI_CURRENCY_CONVERSION_TYPE = "CurrencyConversionType" |
| Global Const HYP_MI_CURRENCY_CATEGORY = "CurrencyCategory" |
| Global Const HYP_MI_TIME_BALANCE_OPTION = "TimeBalanceOption" |
| Global Const HYP_MI_TIME_BALANCE_SKIP_OPTION = "TimeBalanceSkipOption" |
| Global Const HYP_MI_SHARE_OPTION = "ShareOption" |
| Global Const HYP_MI_STORAGE_CATEGORY = "StorageCategory" |
| Global Const HYP_MI_CHILD_COUNT = "ChildCount" |
| Global Const HYP_MI_ATTRIBUTED = "Attributed" |
| Global Const HYP_MI_RELATIONAL_DESCENDANT_PRESENT = "RelDescendantPresent" |
| Global Const HYP_MI_RELATIONAL_PARTITION_ENABLED = "RelPartitionEnabled" |
| Global Const HYP_MI_DEFAULT_ALIAS = "DefaultAlias" |
| Global Const HYP_MI_HIERARCHY_TYPE = "HierarchyType" |
| Global Const HYP_MI_DIM_SOLVE_ORDER = "DimSolveOrder" |
| Global Const HYP_MI_IS_DUPLICATE_NAME = "IsDuplicateName" |
| Global Const HYP_MI_UNIQUE_NAME = "UniqueName" |
| Global Const HYP_MI_ORIGINAL_MEMBER = "OrigMember" |
| Global Const HYP_MI_IS_FLOW_TYPE = "IsFlowType" |
| Global Const HYP_MI_AGGREGATE_LEVEL = "AggLevel" |
| Global Const HYP_MI_FORMAT_STRING = "FormatString" |
| Global Const HYP_MI_ATTRIBUTE_DIMENSIONS = "AttributeDims" |
| Global Const HYP_MI_ATTRIBUTE_MEMBERS = "AttributeMbrs" |
| Global Const HYP_MI_ATTRIBUTE_TYPES = "AttributeTypes" |
| Global Const HYP_MI_ALIAS_NAMES = "AliasNames" |
| Global Const HYP_MI_ALIAS_TABLES = "AliasTables" |
| Global Const HYP_MI_FORMULA = "Formula" |
| Global Const HYP_MI_COMMENT = "Comment" |
| Global Const HYP_MI_LAST_FORMULA = "LastFormula" |
| Global Const HYP_MI_UDAS = "Udas" |