SE GetTransmittalFile

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

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

Definition

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

Returns

SE_STAT_CODE_SUCCESS and *file_location_out_ptr is set to the file location associated with the transmittal, if valid parameters were passed in and the transmittal referenced a valid, open transmittal.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and *file_location_out_ptr is left unaltered, if file_location_out_ptr is NULL.

SE_STAT_CODE_INVALID_OR_NULL_TRANSMITTAL and *file_location_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 *file_location_out_ptr is set to NULL, if store_in is not a handle to a valid SE_Store created by SE_CreateStore().

SE_STAT_CODE_OUT_OF_MEMORY and *file_location_out_ptr is set to NULL, if the API could not allocate the memory for the file location string in file_location_out_ptr.

SE_STAT_CODE_FAILURE and *file_location_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 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_STAT_CODE_SUCCESS	and *file_location_out_ptr is set to the file location associated with the transmittal, if valid parameters were passed in and the transmittal referenced a valid, open transmittal.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and *file_location_out_ptr is left unaltered, if file_location_out_ptr is NULL.
SE_STAT_CODE_INVALID_OR_NULL_TRANSMITTAL	and *file_location_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 *file_location_out_ptr is set to NULL, if store_in is not a handle to a valid SE_Store created by SE_CreateStore().
SE_STAT_CODE_OUT_OF_MEMORY	and *file_location_out_ptr is set to NULL, if the API could not allocate the memory for the file location string in file_location_out_ptr.
SE_STAT_CODE_FAILURE	and *file_location_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.