SE GetTransmittalName

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

extern SE_Return_Code
SE_GetTransmittalName
(
	SE_Transmittal			transmittal_in,	(notes)
	SE_Store			store_in,	(notes)
const	char	*	*	name_out_ptr	(notes)
);

Definition

Given a handle to a transmittal, return the formal transmittal name associated with the transmittal.

Returns

SE_RET_CODE_SUCCESS	and the transmittal name 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 the call was successful.

SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:

SE_STAT_CODE_INACTIONABLE_FAILURE SE_STAT_CODE_INACTIONABLE_FAILURE set if the call fails for any reason.

Parameters Notes

transmittal_in

 the transmittal for which the name is being requested.

store_in

 the store to be used when allocating the string used to return
    the transmittal name.

name_out_ptr

 a pointer to a char* variable from the user.
    A pointer to the transmittal name will be returned via this parameter.
    The storage for the character string returned will be allocated within
    the store passed in.