SE CloseTransmittal

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

extern SE_Status_Code
SE_CloseTransmittal
(
SE_Transmittal	transmittal	(notes)
);

Definition

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

Returns

SE_STAT_CODE_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, etc.) cease to be valid once the transmittal is closed.

SE_STAT_CODE_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_STAT_CODE_FAILURE and no changes are made, if

transmittal has no root object set,

transmittal has a <Transmittal Root> set as the root object, but the version information in its fields doesn't match the DRM version to which the API implementation is bound,

transmittal is not an open transmittal, or

the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Parameters Notes

transmittal

 the transmittal to close.

SE_STAT_CODE_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, etc.) cease to be valid once the transmittal is closed.
SE_STAT_CODE_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_STAT_CODE_FAILURE	and no changes are made, if transmittal has no root object set, transmittal has a <Transmittal Root> set as the root object, but the version information in its fields doesn't match the DRM version to which the API implementation is bound, transmittal is not an open transmittal, or the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.