Gets member information for the specified member.
Syntax
ESS_FUNC_M EssOtlGetMemberInfo (hOutline, hMember, pInfo);
Parameter | Data Type | Description |
---|---|---|
hOutline | ESS_HOUTLINE_T | Outline context handle. |
hMember | ESS_HMEMBER_T | Member handle. |
pInfo | ESS_MBRINFO_T | Pointer to a member information structure, allocated by the API. |
Notes
Call EssOtlFindMember() to retrieve the member handle.
Call EssFreeStructure() to free the information structure.
Two fields of the ESS_MBRINFO_T structure are for attributes only:
fAttributed
Attribute
Return Value
Returns 0 if successful.
Example
#include <essapi.h> #include <essotl.h> ESS_STS_T sts = 0; ESS_OBJDEF_T Object; ESS_HOUTLINE_T hOutline; ESS_HMEMBER hMemberJan; ESS_PMBRINFO_T pMbrInfo; ESS_APPNAME_T szAppName; ESS_DBNAME_T szDbName; ESS_OBJNAME_T szFileName; memset(&Object, '\0', sizeof(Object)); Object.hCtx = hCtx; Object.ObjType = ESS_OBJTYPE_OUTLINE; strcpy(szAppName, "Sample"); strcpy(szDbName, "Basic"); strcpy(szFileName, "Basic"); Object.AppName = szAppName; Object.DbName = szDbName; Object.FileName = szFileName; sts = EssOtlOpenOutline(hCtx, &Object, ESS_TRUE, ESS_TRUE, &hOutline); if (!sts) { sts = EssOtlFindMember(hOutline, "Jan", &hMemberJan); } if (!sts && hMemberJan) { sts = EssOtlGetMemberInfo(hOutline, hMemberJan, &pMbrInfo); } if (pMbrInfo) { EssOtlFreeStructure(hOutline, ESS_DT_STRUCT_MBRINFO, 1, pMbrInfo); }