EssOtlGetMemberInfoArray

Gets member information for the specified member array.

Syntax

ESS_FUNC_M EssOtlGetMemberInfoArray (hOutline, memberCount, hMemberArr, pInfoArr, pStsArr);

Parameter	Data Type	Description
hOutline	ESS_HOUTLINE_T	Outline handle.
memberCount	ESS_SHORT_T	Count of members in the input array.
hMemberArr	ESS_HMEMBER_T	Array of memberCount member handles.
pInfoArr	ESS_PPMBRINFO_T	Array of memberCount member information pointers.
pStsArr	ESS_STS_T	Array of memberCount status return codes. If any errors occur, the function returns the value of the first error encountered.

Notes

Call EssOtlFindMember() to retrieve the member handles.
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. If unsuccessful, the pStsArr has the return code for each member.

Example

#include <essapi.h>
#include <essotl.h>
 
ESS_OBJDEF_T       Object;
ESS_HOUTLINE_T     hOutline;
ESS_HMEMBER        hMemberArr[3];
ESS_PMBRINFO_T     pMbrInfoArr[3];
ESS_STS_T          stsArr[3];
ESS_APPNAME_T      szAppName;
ESS_DBNAME_T       szDbName;
ESS_OBJNAME_T      szFileName;
ESS_SHORT_T        i;
 
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", &hMemberArr[0]);
}
if (!sts)
{
   sts = EssOtlFindMember(hOutline, "Feb", &hMemberArr[1]);
}
if (!sts)
{
   sts = EssOtlFindMember(hOutline, "Mar", &hMemberArr[2]);
}
if (!sts)
{
   sts = EssOtlGetMemberInfoArray(hOutline, 3, hMemberArr, pMbrInfoArr, stsArr);
}
for (i = 0; i < 3; i++)
{
   if (pMbrInfoArr[i])
   {
      EssOtlFreeStructure(hOutline, ESS_DT_STRUCT_MBRINFO, 1, pMbrInfoArr[i]);
   }
}