|
SEDRIS Reference Manual
APPENDIX A - LEVEL 0 READ and WRITE API Functions SE GetUniqueTransmittalID |
|---|
| extern SE_Status_Code | ||||
| SE_GetUniqueTransmittalID | ||||
| ( | ||||
| SE_Transmittal | transmittal_in, | (notes) | ||
| SE_Store | store_in, | (notes) | ||
| char | * | * | identifier_out_ptr | (notes) |
| ); | ||||
Given an SE_Transmittal, retrieves an ASCII string identifier for the associated transmittal, which can then be compared with identifiers from other transmittals.
| SE_STAT_CODE_SUCCESS | and *identifier_out_ptr is set appropriately, if valid parameters were passed in and all operations succeeded. |
| SE_STAT_CODE_NULL_REQUIRED_PARAMETER | and *identifier_out_ptr is left unchanged, if identifier_out_ptr is NULL. |
| SE_STAT_CODE_INVALID_OR_NULL_TRANSMITTAL | and *identifier_out_ptr is set to NULL, if transmittal_in is not a handle to a valid, open transmittal. |
| SE_STAT_CODE_INVALID_OR_NULL_STORE | and *identifier_out_ptr is set as for SE_STAT_CODE_INVALID_OR_NULL_TRANSMITTAL, if store_in is not a handle to a valid SE_Store created by SE_CreateStore(). |
| SE_STAT_CODE_OUT_OF_MEMORY | and *identifier_out_ptr is set as for SE_STAT_CODE_INVALID_OR_NULL_TRANSMITTAL, if memory could not be allocated for the requested identifier. |
| SE_STAT_CODE_FAILURE | and *identifier_out_ptr is set as for SE_STAT_CODE_INVALID_OR_NULL_TRANSMITTAL, implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time. |
handle to the transmittal for which an identifier is
requested
handle to the store which will manage the memory associated
with the identifier being retrieved
pointer to a 'char *' in the user's memory space
where the identifier will be placed. The store_in is responsible
for the memory associated with the
identifier.
Prev: SE_GetTransmittalVersionInformation.
Next: SE_GetUnresolvedObjectFromPublishedLabel.
Up:Index.
|