EssOtlGetOutlineInfo

Returns information about the outline file.

Syntax

ESS_FUNC_M EssOtlGetOutlineInfo (hOutline, ppInfo);

Parameter	Data Type	Description
hOutline	ESS_HOUTLINE_T	Outline context handle.
ppInfo	ESS_OUTLINEINFO_T	Pointer to a pointer to a structure allocated by the API for storing outline information.

Notes

Use EssFree() to free the information structure.

Return Value

Returns 0 if successful.

Example

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

ESS_STS_T   sts = 0;
ESS_HOUTLINE_T   hOutline;
ESS_POUTLINEINFO_T pInfo = ESS_NULL;
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 = EssOtlGetOutlineInfo(hOutline, &pInfo);
}

if(pInfo)
{
 EssFree(hInst, pInfo);
}