SE GetTransmittalLocation

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

extern SE_Return_Code
SE_GetTransmittalLocation
(
SE_Transmittal		transmittal_in,	¹
SE_Store		store_in,	²
SE_URL	*	file_location_out_ptr	³
);

Definition

Given the handle to the transmittal specified in transmittal, this function returns in location the URL specifying the location of the transmittal.

Returns

SE_RETCOD_SUCCESS	and the transmittal file is returned.
SE_RETCOD_FAILURE	and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:

SE_STATCODE_SUCCESS set if valid parameters were passed in and the transmittal referenced a valid, open transmittal.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_OUT_OF_MEMORY and no changes are made if sufficient memory could not be allocated.

SE_STATCODE_C_STORE_INVALID and no changes are made if store_in is not a handle to a valid SE_Store.

SE_STATCODE_INACTIONABLE_FAILURE and no changes are made if

transmittal is not a valid handle to an open transmittal, or

the function fails for any other reason.

Parameters Notes

¹ the transmittal for which the file location should be returned.

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

³ a pointer to an SE_URL 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_STATCODE_OUT_OF_MEMORY	and no changes are made if sufficient memory could not be allocated.
SE_STATCODE_C_STORE_INVALID	and no changes are made if store_in is not a handle to a valid SE_Store.
SE_STATCODE_INACTIONABLE_FAILURE	and no changes are made if transmittal is not a valid handle to an open transmittal, or the function fails for any other reason.