SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE FreeRemainingObjectsList
extern SE_Return_Code
SE_FreeRemainingObjectsList
(
SE_Remaining_Objects_List *to_free_list1
);

Definition

Frees the data associated with the fields of the remaining objects list returned by SE_GetRemainingObjectsList().


Returns

SE_RETCOD_SUCCESS and the objects in the list are 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 valid parameters were passed in and all operations succeeded.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_INACTIONABLE_FAILURE and no changes are made, if
  1. any of the fields of *to_free_list are already set to 0 (for counts) or NULL (for pointers), or
  2. the call fails for any other reason

Parameters Notes

1 a pointer to a SE_Remaining_Objects_List structure, which contains data returned by SE_GetRemainingObjectsList().

Prev: SE_FreePackedHierarchy. Next: SE_FreeRemainingPackedHierarchiesList. Up:Index.

Last updated: July 26, 2006 Copyright © 2006 SEDRIS™