SE FreeRemainingPackedHierarchiesList

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

extern SE_Status_Code
SE_FreeRemainingPackedHierarchiesList
(
SE_Remaining_Packed_Hierarchies_List	*	to_free	(notes)
);

Definition

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

Returns

SE_STAT_CODE_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_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_Remaining_Packed_Hierarchies_List
    structure that contains data returned by
    SE_GetRemainingPackedHierarchies().

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