SE FreeTransmittal

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

extern SE_Status_Code
SE_FreeTransmittal
(
SE_Transmittal	to_free	(notes)
);

Definition

Frees the memory directly associated with the specified transmittal handle. The memory was allocated by this API during an earlier call to SE_GetTransmittalFromID(), SE_GetTransmittalFromObject().

NOTE: This function does not close the transmittal.

Returns

SE_STAT_CODE_SUCCESS and the given handle to the transmittal is freed, if a valid parameter was passed in.

SE_STAT_CODE_INVALID_OR_NULL_TRANSMITTAL and no changes are made, if to_free wasn't a handle to a valid, active (i.e., open and unfreed) transmittal.

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 handle to the transmittal that the caller
    wishes to free.

SE_STAT_CODE_SUCCESS	and the given handle to the transmittal is freed, if a valid parameter was passed in.
SE_STAT_CODE_INVALID_OR_NULL_TRANSMITTAL	and no changes are made, if to_free wasn't a handle to a valid, active (i.e., open and unfreed) transmittal.
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.