Function Name: Close Transmittal

Definition

Closes the given transmittal and frees any and all memory allocated to hold the transmittal's representation.

Returns

SE_SUCCESS - and the transmittal is closed, if a valid parameter was passed in and all operations succeeded. Please note that any handles referring to that transmittal (SE_TRANSMITTALs, SE_OBJECTs, SE_SEARCH_FILTERs, etc.) cease to be valid once the transmittal is closed.

SE_INVALID_OR_NULL_TRANSMITTAL - and no changes are made, if transmittal is not a handle to a valid, active (i.e., not previously closed) transmittal.

SE_FAILURE - and no changes are made, if

  1. transmittal is not an open transmittal, or
  2. 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_CloseTransmittal
(
SE_TRANSMITTAL transmittal (notes)
);

Parameters Notes

transmittal

 the transmittal to close.
Prev: Clone Object. Next: Compare Object IDs. Up:Index.