SE FreeTransmittal

SEDRIS Reference Manual APPENDIX A - Transmittal Access Level 0 API Functions SE FreeTransmittal

extern SE_Return_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_GetTransmittalFromObject().

NOTE: This function does not close the transmittal.

Returns

SE_RET_CODE_SUCCESS and the transmittal handle is 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 a valid parameter was passed in.

SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:

SE_STAT_CODE_INACTIONABLE_FAILURE set if the call fails for any reason.

Parameters Notes

to_free

 a handle to the transmittal that the caller
    wishes to free.

SE_RET_CODE_SUCCESS	and the transmittal handle is deallocated.
SE_RET_CODE_FAILURE	and the status code is set appropriately if the call failed.