Deallocates the object handle array.
Syntax
ESS_FUNC_M EssOtlFreeObjectArray(hOutline, count, objHandles)
Parameter | Data Type | Description |
---|---|---|
hOutline | ESS_HOUTLINE_T | Outline handle (Query mode only) |
count | ESS_ULONG_T | Count of object handles |
objHandles | ESS_PHOBJECT_T | Array of object handles to be de allocated |
Return Value
Returns:
0—If successful
Error number—If unsuccessful
Example
void TestFreeObjectArray()
{
ESS_STS_T sts = ESS_STS_NOERR;
ESS_HOUTLINE_T hOutline = ESS_NULL;
ESS_OBJDEF_T Object;
ESS_STR_T objNames[1];
ESS_OBJECT_TYPES objType;
ESS_ULONG_T count;
ESS_PHOBJECT_T hObjHandles = ESS_NULL;
memset(&Object, '\0', sizeof(Object));
Object.hCtx = hCtx;
Object.ObjType = ESS_OBJTYPE_OUTLINE;
Object.AppName = szAppName;
Object.DbName = szDbName;
Object.FileName = szFileName;
/* Set up */
sts = EssOtlOpenOutlineQuery(hCtx, &Object, &hOutline);
count = 2;
objType = OBJECT_SMARTLIST;
objNames[0] = "Smartlist1";
objNames[1] = "Smartlist2";
/* Query objects */
sts = EssOtlQueryObjects(hOutline, objType,
objNames, &Count, &hObjHandles);
/* Free object array */
if(hObjHandles)
{
sts = EssOtlFreeObjectArray(hOutline, count,
hObjHandles);
}
/* Close outline */
sts = EssOtlCloseOutline(hOutline);
}
See Also