Function Name: Free Packed Hierarchy

Definition

Frees the data associated with the fields of a packed hierarchy.

Returns

SE_SUCCESS - and the packed hierarchy data is freed, if a valid parameter was passed in and all operations succeeded. 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_FreePackedHierarchy
(
SE_PACKED_HIERARCHY *to_free (notes)
);

Parameters Notes

to_free

 a pointer to a SE_PACKED_HIERARCHY structure that contains
    data returned by SE_GetPackedHierarchy().
Prev: Free Object ID. Next: Free Reference Symbol. Up:Index.