EssOtlFreeSmartListInfo

Frees the Text List (SmartList) object obtained by EssOtlGetSmartListInfo.

Syntax

ESS_FUNC_M EssOtlFreeSmartListInfo(hOutline, pSmartListInfo);

Parameter	Data Type	Description
hOutline	ESS_HOUTLINE_T	The source Essbase outline for the Text List (SmartList).
pSmartListInfo	ESS_PSMARTLISTINFO_T	Text List (SmartList) information.

Return Value

Returns:

0—If successful
Error number—If unsuccessful

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);

}