SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE CloseTransmittal
extern SE_Return_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_RET_CODE_SUCCESS and the specified trasmittal is closed.
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 all operations succeeded. (SE_Transmittals, SE_Objects, etc.) cease to be valid once the transmittal is closed.

SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:

SE_STAT_CODE_INACTIONABLE_FAILURE set if
  1. transmittal has no root object set,
  2. 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,
  3. transmittal is not an open transmittal, or
  4. the call failed for any other reason.

Parameters Notes


transmittal

 the transmittal to close.

Prev: SE_CloneObject. Next: SE_CreateObject. Up:Index.

Last updated: August 23, 2005 Copyright © 2005 SEDRIS™