EssOtlSetOutlineInfo

Sets outline information.

Syntax

ESS_FUNC_M EssOtlSetOutlineInfo (hOutline, pInfo);

Parameter	Data Type	Description
hOutline	ESS_HOUTLINE_T	Outline context handle.
pInfo	ESS_OUTLINEINFO_T	Pointer to a structure allocated by the caller to store outline information.

Notes

Only some of the fields of the ESS_OUTLINEINFO_T structure are used to set information. See the structure description for more information.
If the fCaseSensitive flag in the ESS_OUTLINEINFO_T structure is being changed from ESS_TRUE to ESS_FALSE, and this causes duplicate member names, the call will fail. If your outline is a duplicate member name outline, use EssOtlSetOutlineInfoEx instead of this function.

Return Value

Returns 0 if successful; otherwise, returns an error.

Example

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

ESS_STS_T   sts = 0;
ESS_FALSE = 0;
ESS_TRUE  = 1;
ESS_POUTLINEINFO_T pInfo = ESS_NULL;
ESS_HOUTLINE_T   hOutline;
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,
      &hOutline);

if (!sts)
{
 sts = EssOtlGetOutlineInfo(hOutline, &pInfo);
}

if (!sts && Info)
{
 pInfo->fCaseSensitive = ESS_FALSE;
 sts = EssOtlSetOutlineInfo(hOutline, pInfo);
}

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