|
SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE GetUniqueTransmittalID |
|---|
| extern SE_Return_Code | |||
| SE_GetUniqueTransmittalID | |||
| ( | |||
| SE_Transmittal | transmittal_in, | 1 | |
| SE_Store | store_in, | 2 | |
| SE_String | * | identifier | 3 |
| ); | |||
Given the handle to a transmittal specified in transmittal_in, this function returns in identifier a string identifier for the associated transmittal that can then be compared with identifiers from other transmittals.
| SE_RETCOD_SUCCESS | and the unique transmittal id is returned. |
| SE_RETCOD_FAILURE | and the status code is set appropriately if the call failed. |
SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:
| SE_STATCODE_SUCCESS | set if valid parameters were passed in and all operations succeeded. |
SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:
| SE_STATCODE_C_STORE_INVALID | set if store_in is not a handle to a valid SE_Store. |
| SE_STATCODE_INACTIONABLE_FAILURE | set if the call fails for any reason. |
1 handle to the transmittal for which an identifier is requested
2 handle to the store which will manage the memory associated with the identifier being retrieved
3 pointer to an SE_String 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.
|