Function Name: Free Remaining Packed Hierarchies List

Definition

Frees the data associated with the fields of the remaining hierarchies list returned by SE_GetRemainingPackedHierarchies().

Returns

SE_SUCCESS - and the remaining packed hierarchy data is freed, if valid parameters were passed in. In this case, the fields of *to_free are set to 0 (for counts) or NULL (for pointers).

SE_NULL_REQUIRED_PARAMETER - and *to_free is left unaltered, if to_free was NULL.

SE_FAILURE - and no changes are made, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Prototype


extern SE_STATUS_CODE_ENUM
SE_FreeRemainingPackedHierarchiesList
(
SE_REMAINING_PACKED_HIERARCHIES_LIST *to_free (notes)
);

Parameters Notes

to_free

 a pointer to a SE_REMAINING_PACKED_HIERARCHIES_LIST
    structure that contains data returned by
    SE_GetRemainingPackedHierarchies().
Prev: Free Remaining Objects List. Next: Free Search Filter. Up:Index.