SE GetTransmittalFile

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

extern SE_Return_Code
SE_GetTransmittalFile
(
	SE_Transmittal			transmittal_in,	(notes)
	SE_Store			store_in,	(notes)
const	char	*	*	file_location_out_ptr	(notes)
);

Definition

Given a handle to a transmittal, retrieves the file location associated with the transmittal.

Returns

SE_RET_CODE_SUCCESS and the transmittal file 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 transmittal referenced a valid, open transmittal.

SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:

SE_STAT_CODE_INACTIONABLE_FAILURE set if the call failed for any reason.

Parameters Notes

transmittal_in

 the transmittal for which the file location should be
    returned.

store_in

 the store to be used when allocated the string used to return
    the file location.

file_location_out_ptr

 a pointer to a char* variable from the user.
    The file location will be returned via this pointer.  The storage for
    the character string returned in this structure will be allocated within
    the store passed in.

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