SE GetTransmittalName

SEDRIS Reference Manual APPENDIX A - LEVEL 0 READ and WRITE API Functions SE GetTransmittalName

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

Definition

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

Returns

SE_STAT_CODE_SUCCESS and *name_out_ptr is set to the transmittal's formal name, if valid parameters were passed in.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and *name_out_ptr is left unaltered, if either name_out_ptr or store_in is NULL.

SE_STAT_CODE_INVALID_OR_NULL_TRANSMITTAL and *name_out_ptr is set to NULL, if transmittal_in is not a handle to a valid, open SEDRIS transmittal.

SE_STAT_CODE_INVALID_OR_NULL_STORE and *name_out_ptr is set to NULL, if store_in is not a handle to a valid, active (i.e., not freed) SE_Store created by SE_CreateStore().

SE_STAT_CODE_OUT_OF_MEMORY and *name_out_ptr is set to NULL, if the API could not allocate the memory for the name string in name_out_ptr.

SE_STAT_CODE_FAILURE and *name_out_ptr is set to NULL, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

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.

SE_STAT_CODE_SUCCESS	and *name_out_ptr is set to the transmittal's formal name, if valid parameters were passed in.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and *name_out_ptr is left unaltered, if either name_out_ptr or store_in is NULL.
SE_STAT_CODE_INVALID_OR_NULL_TRANSMITTAL	and *name_out_ptr is set to NULL, if transmittal_in is not a handle to a valid, open SEDRIS transmittal.
SE_STAT_CODE_INVALID_OR_NULL_STORE	and *name_out_ptr is set to NULL, if store_in is not a handle to a valid, active (i.e., not freed) SE_Store created by SE_CreateStore().
SE_STAT_CODE_OUT_OF_MEMORY	and *name_out_ptr is set to NULL, if the API could not allocate the memory for the name string in name_out_ptr.
SE_STAT_CODE_FAILURE	and *name_out_ptr is set to NULL, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.