SE OpenTransmittalByLocation

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

extern SE_Return_Code
SE_OpenTransmittalByLocation
(
const	SE_URL	*	file_location,	¹
	SE_Encoding		encoding,	²
	SE_Access_Mode		access_mode,	³
	SE_Transmittal	*	transmittal_out_ptr	⁴
);

Definition

This function opens a transmittal for access, based on the mode specified by access_mode. This function specifies the transmittal to be opened using the location of the file containing the transmittal and its DRM objects. If this function is successful, transmittal returns a handle to the newly opened transmittal.

Returns

SE_RETCOD_SUCCESS	and the opened tranmittal 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 name was the name of a valid file that this API was able to open as a transmittal.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_TRANSMITTAL_INACCESSIBLE	set if the file_location was not accessible by the API. This could occur if the file was opened for read-only or update and the file did not exist, or the file location specified a non-local file and the API had no transport mechanism for accessing the remote file.
SE_STATCODE_INVALID_ACCESS_MODE	set if the file_location was found, but the security permissions of the underlying system (OS / filesystem) prohibited access to the file in the mode specified. This could occur if the access mode specified was SE_AM_CREATE or SE_AM_UPDATE and the file was marked read-only, or if no access was permitted for the account running the application. This condition could also occur if SE_AM_CREATE or SE_AM_UPDATE mode was requested and the API implementation encoding did not support the write capability.
SE_STATCODE_UNSUPPORTED_ENCODING	set if the encoding parameter or the default file extension specified a format that is not supported by the implementation(s) encoding of the SEDRIS API linked to the application.
SE_STATCODE_INACTIONABLE_FAILURE	set if the call fails for any other reason.

Parameters Notes

¹ the file location of the transmittal to be opened.

² the API implementation encoding to use when opening this file. If the specified API can't open the given file location then the API will return a status code indicating why it could not be opened. If encoding is NULL, then the API will try to open the given transmittal based on the extension of the file location. See also SE_GetEncoding().

³ the mode (read-only, create, update, etc.) that the transmittal should be opened in.

⁴ a pointer to the SE_Transmittal from the user. The *transmittal_out_ptr value will be initialized by this function.