SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE FreePackedHierarchy
extern SE_Return_Code
SE_FreePackedHierarchy
(
SE_Packed_Hierarchy  *to_free_hierarchy1
);

Definition

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


Returns

SE_RETCOD_SUCCESS and the packed hierarchy is deallocated.
SE_RETCOD_FAILURE and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:

SE_STATCODE_SUCCESS set if a valid parameter was passed in and all operations succeeded.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_INACTIONABLE_FAILURE set if the call fails for any reason.

Parameters Notes

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


Prev: SE_FreeObject. Next: SE_FreeRemainingObjectsList. Up:Index.