SE FreeRemainingObjectsList

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	(notes)
);

Definition

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

Returns

SE_RET_CODE_SUCCESS	and the objects in the list are deallocated.
SE_RET_CODE_FAILURE	and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RET_CODE_SUCCESS is returned:

SE_STAT_CODE_SUCCESS set if valid parameters were passed in and all operations succeeded.

SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:

SE_STAT_CODE_INACTIONABLE_FAILURE and no changes are made, if

any of the fields of *to_free are already set to 0 (for counts) or NULL (for pointers), or

the call fails for any other reason

Parameters Notes

to_free

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