EssOtlGetMemberField

Description

EssOtlGetMemberField() returns data for the specified field of a specified outline member.

Syntax

ESS_FUNC_M EssOtlGetMemberField(hOutline, hMember, MbrFieldID, ppFieldElement);
ESS_HOUTLINE_T hOutline
ESS_HMEMBER_T hMember
ESS_ULONG_T MbrFieldID
ESS_PPVOID_T ppFieldElement

Parameters

hOutline Essbase outline handle. This must have been returned from EssOtlOpenOutlineQuery().
hMember Member handle returned by EssOtlQueryMembersEx().
MbrFieldID One of the following member field identifier constants:
ESS_OTLQRYMBR_NONE
ESS_OTLQRYMBR_NAME
ESS_OTLQRYMBR_LEVEL
ESS_OTLQRYMBR_GENERATION
ESS_OTLQRYMBR_CONSOLIDATION
ESS_OTLQRYMBR_TWOPASS
ESS_OTLQRYMBR_EXPENSE
ESS_OTLQRYMBR_CURRENCYCONVTYPE
ESS_OTLQRYMBR_CURRENCYCONVNAME
ESS_OTLQRYMBR_TIMEBALANCE
ESS_OTLQRYMBR_SKIP
ESS_OTLQRYMBR_SHARE
ESS_OTLQRYMBR_STORAGE
ESS_OTLQRYMBR_CATEGORY
ESS_OTLQRYMBR_STORAGECATEGORY
ESS_OTLQRYMBR_COMMENT
ESS_OTLQRYMBR_CHILDCOUNT
ESS_OTLQRYMBR_NUMBER
ESS_OTLQRYMBR_DIMNAME
ESS_OTLQRYMBR_DIMNUMBER
ESS_OTLQRYMBR_ALIASNAME
ESS_OTLQRYMBR_NEXTNAME
ESS_OTLQRYMBR_PREVNAME
ESS_OTLQRYMBR_PARENTNAME
ESS_OTLQRYMBR_CHILDNAME
ESS_OTLQRYMBR_UDA
ESS_OTLQRYMBR_FORMULA
ESS_OTLQRYMBR_LASTFORMULA
ESS_OTLQRYMBR_EXTCOMMENT
ESS_OTLQRYMBR_ALIASCOMBO
ESS_OTLQRYMBR_VALID
ESS_OTLQRYMBR_CURRENCYCONVDB
ESS_OTLQRYMBR_STATUS
ESS_OTLQRYMBR_MBRINFO
ppFieldElement Returned pointer to the required field element.

Return Value

The return value is zero if the function call was successful.

Notes

Example

See Extended Member Query for an example that uses EssOtlQueryMembersEx(), EssOtlGetMemberField(), and ESS_OTLQUERYERRORLIST_T, and includes calls to EssOtlFreeMembers() and EssFree().

See Also

EssFree()
EssOtlGetDimensionUserAttributes()
EssOtlOpenOutlineQuery()
EssOtlQueryMembers()
EssOtlQueryMembersByName()
EssOtlQueryMembersEx()