Returns the Text List (SmartList) information for the Text List (SmartList) passed in the hSmartList handle. This must be followed by an EssOtlFreeSmartListInfo call on ppSmartListInfo.
Syntax
ESS_FUNC_M EssOtlGetSmartListInfo(hOutline, hSmartList, **ppSmartListInfo);
Parameter | Data Type | Description |
---|---|---|
hOutline | ESS_HOUTLINE_T | Outline handle |
hSmartlist | ESS_HSMARTLIST_T | Text List (SmartList) handle |
**ppSmartListInfo | ESS_SMARTLISTINFO_T | Contains the Text List (SmartList) information structure. |
Return Value
Returns:
0—If successful
ppSmartListInfo contains the Text List (SmartList) information.
Error number—If unsuccessful
ppSmartListInfo is NULL.
Example
DisplaySmartListInfo(ESS_HOUTLINE_T hOutline, ESS_PHOBJECT_T ObjHandles)
{
ESS_STS_T sts = ESS_STS_NOERR;
ESS_PSMARTLISTINFO_T SmartListInfo;
ESS_ULONG_T i;
sts = EssOtlGetSmartListInfo(hOutline, ObjHandles,
&SmartListInfo);
if(!sts)
{
printf("\n");
printf("\tName: %s\n", SmartListInfo->szName);
printf("\tMissing Name: %s\n",
SmartListInfo->szMissingName);
printf("\tOut of Range Name: %s\n",
SmartListInfo->szOutOfRangeName);
printf("\tusLen: %d\n", SmartListInfo->usLen);
for (i = 0; i < SmartListInfo->usLen; i++)
{
printf("\tpIDs: %d, \tpszText[%d]: %s\n",
SmartListInfo->pIDs[i], i,
SmartListInfo->ppszText[i]);
}
printf("\n");
}
else
printf("\t\tEssOtlGetSmartListInfo sts: %d\n",sts);
if(SmartListInfo)
sts = EssOtlFreeSmartListInfo(hOutline, SmartListInfo);
}