Returns data for the specified field of a specified outline member.
Syntax
ESS_FUNC_M EssOtlGetMemberField(hOutline, hMember, MbrFieldID, ppFieldElement);
| Parameter | Data Type | Description |
|---|---|---|
hOutline | ESS_HOUTLINE_T | Essbase outline handle. This must have been returned from EssOtlOpenOutlineQuery(). |
hMember | ESS_HMEMBER_T | Member handle returned by EssOtlQueryMembersEx(). |
MbrFieldID | ESS_ULONG_T | A member field identifier constant. See Notes. |
ppFieldElement | ESS_PPVOID_T | Returned pointer to the required field element. |
Notes
EssOtlGetMemberField() takes a member handle and field identifier, and returns a pointer to data for the specified field.
If you specify for MbrFieldID a constant that was not in the fieldSelection string in EssOtlQueryMembersEx(), EssOtlGetMemberField() returns the error OTLAPI_ERR_MBRINVALID.
The caller of EssOtlGetMemberField() should call EssFree() to free the memory set aside for the specified field data.
The following member field identifier constants are valid values for MbrFieldID:
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_ATTRIBUTED
True—if attributes are associated
ESS_OTLQRYMBR_ASSOCATTRDIMNAME
Associated Attribute Dimension name
ESS_OTLQRYMBR_ASSOCATTRMEMNAME
Associated Attribute Member name
ESS_OTLQRYMBR_ASSOCATTRVALUE
Associated Attribute value
ESS_OTLQRYMBR_ATTRVALUE
Attribute value of the member
ESS_OTLQRYMBR_UNIQUENAME
Unique Name of the member
ESS_OTLQRYMBR_FORMATSTRING
Format String of the member
ESS_OTLQRYTIDIM_TIMEPERIODS
Query Time dimension for time periods list
ESS_OTLQRYMBR_MBRINFO
Return Value
The return value is zero if the function call was successful.
Example
See Extended Member Query Code Example for an example that uses EssOtlQueryMembersEx(), EssOtlGetMemberField(), and ESS_OTLQUERYERRORLIST_T, and includes calls to EssOtlFreeMembers() and EssFree().
See Also