SE GetUniqueTransmittalID

SEDRIS Reference Manual APPENDIX A - Transmittal Access Level 0 API Functions SE GetUniqueTransmittalID

extern SE_Return_Code
SE_GetUniqueTransmittalID
(
	SE_Transmittal			transmittal_in,	(notes)
	SE_Store			store_in,	(notes)
const	char	*	*	identifier_out_ptr	(notes)
);

Definition

Given an SE_Transmittal, retrieves an ASCII string identifier for the associated transmittal, which can then be compared with identifiers from other transmittals.

Returns

SE_RET_CODE_SUCCESS and the unique transmittal id is returned.

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 valid parameters were passed in and all operations succeeded.

SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:

SE_STAT_CODE_INACTIONABLE_FAILURE set if the call fails for any reason.

Parameters Notes

transmittal_in

 handle to the transmittal for which an identifier is
    requested

store_in

 handle to the store which will manage the memory associated
    with the identifier being retrieved

identifier_out_ptr

 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.

SE_RET_CODE_SUCCESS	and the unique transmittal id is returned.
SE_RET_CODE_FAILURE	and the status code is set appropriately if the call failed.