SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE CloseTransmittal
extern SE_Return_Code
SE_CloseTransmittal
(
SE_Transmittal  transmittal1
);

Definition

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


Returns

SE_RETCOD_SUCCESS and the specified trasmittal is closed.
SE_RETCOD_FAILURE and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:

SE_STATCODE_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_RETCOD_FAILURE is returned:

SE_STATCODE_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

1 the transmittal to close.

Prev: SE_CloneObjectHandle. Next: SE_CreateObject. Up:Index.

Last updated: July 1, 2009 Copyright © 2009 SEDRIS™