SE FreePackedHierarchy

SEDRIS Reference Manual APPENDIX A - LEVEL 0 READ and WRITE API Functions SE FreePackedHierarchy

extern SE_Status_Code
SE_FreePackedHierarchy
(
SE_Packed_Hierarchy	*	to_free	(notes)
);

Definition

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

Returns

SE_STAT_CODE_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_STAT_CODE_NULL_REQUIRED_PARAMETER and *to_free is left unaltered, if to_free was NULL.

SE_STAT_CODE_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.

Parameters Notes

to_free

 a pointer to a SE_Packed_Hierarchy structure that contains
    data returned by SE_GetPackedHierarchy().

SE_STAT_CODE_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_STAT_CODE_NULL_REQUIRED_PARAMETER	and *to_free is left unaltered, if to_free was NULL.
SE_STAT_CODE_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.