Function Name: Free Transmittal

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_SUCCESS - and the given handle to the transmittal is freed, if a valid parameter was passed in.

SE_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_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.

Prototype


extern SE_STATUS_CODE_ENUM
SE_FreeTransmittal
(
SE_TRANSMITTAL to_free (notes)
);

Parameters Notes

to_free

 an SE_TRANSMITTAL (a handle to a transmittal) that the
    application wants to free.
Prev: Free Store. Next: Get Aggregate. Up:Index.