EssOtlGetFirstMember

Returns a member handle to the first member in the outline. The first member is the first dimension defined in the outline.

Syntax

ESS_FUNC_M EssOtlGetFirstMember (hOutline, phMember);
ParameterData TypeDescription

hOutline

ESS_HOUTLINE_T

Outline context handle.

phMember

ESS_PHMEMBER_T

Pointer for return of a member handle of the first member in the outline. This parameter is passed to subsequent calls for traversing the outline.

Return Value

Returns 0 if successful.

Example

#include <essapi.h>
#include <essotl.h>

ESS_STS_T          sts = 0;
ESS_HOUTLINE_T     hOutline;
ESS_MEMBER_T       hMemberFirst
ESS_OBJDEF_T       Object;
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 = EssOtlGetFirstMember(hOutline,
         &hMemberFirst);
}

See Also