SE OpenTransmittalByFile

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

extern SE_Status_Code
SE_OpenTransmittalByFile
(
const	char		file_location[],	(notes)
const	char		implementation_identifier[],	(notes)
	SE_Access_Mode		access_mode,	(notes)
	SE_Transmittal	*	transmittal_out_ptr	(notes)
);

Definition

Opens a SEDRIS transmittal for access, based on the mode specified. This function specifies the SEDRIS transmittal to be opened using the file name of the file / format containing the SEDRIS transmittal and its objects.

Returns

SE_STAT_CODE_SUCCESS and *transmittal_out_ptr is set to point to the transmittal, 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 SEDRIS transmittal.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and *transmittal_out_ptr is left unaltered, if either the file_location or transmittal_out_ptr is NULL.

SE_STAT_CODE_TRANSMITTAL_UNACCESSIBLE and *transmittal_out_ptr is set to NULL, 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_STAT_CODE_INVALID_ACCESS_MODE and *transmittal_out_ptr is set to NULL, 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 create or 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 create or update mode was requested and the API implementation did not support the write capability.

SE_STAT_CODE_UNSUPPORTED_FORMAT and *transmittal_out_ptr is set to NULL, if the implementation_identifier parameter or the default file extension specified a format that is not supported by the implementation(s) of the SEDRIS API linked to the application.

SE_STAT_CODE_OUT_OF_MEMORY and *transmittal_out_ptr is set to NULL, if *transmittal_out_ptr could not be allocated, or if there is insufficient memory for any other part of the process of opening the transmittal.

SE_STAT_CODE_FAILURE and *transmittal_out_ptr is set to NULL, if

dynamic binding is specified at compile time, but the shared library for the specified API implementation cannot be found,

dynamic binding is specified at compile time, but the API implementation specified does not provide this function in its shared library,

any problems not covered by the above are encountered while finding or opening the SEDRIS transmittal specified by the file_location parameter.

Parameters Notes

file_location

 the file location of the SEDRIS transmittal to be opened.

implementation_identifier

 identifies the API implementation
    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 implementation_identifier is NULL, then
    the API will try to open the given SEDRIS transmittal based on the
    extension of the file location.

    See also SE_GetImplementationIdentifier().

access_mode

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

transmittal_out_ptr

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

SE_STAT_CODE_SUCCESS	and *transmittal_out_ptr is set to point to the transmittal, 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 SEDRIS transmittal.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and *transmittal_out_ptr is left unaltered, if either the file_location or transmittal_out_ptr is NULL.
SE_STAT_CODE_TRANSMITTAL_UNACCESSIBLE	and *transmittal_out_ptr is set to NULL, 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_STAT_CODE_INVALID_ACCESS_MODE	and *transmittal_out_ptr is set to NULL, 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 create or 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 create or update mode was requested and the API implementation did not support the write capability.
SE_STAT_CODE_UNSUPPORTED_FORMAT	and *transmittal_out_ptr is set to NULL, if the implementation_identifier parameter or the default file extension specified a format that is not supported by the implementation(s) of the SEDRIS API linked to the application.
SE_STAT_CODE_OUT_OF_MEMORY	and transmittal_out_ptr is set to NULL, if transmittal_out_ptr could not be allocated, or if there is insufficient memory for any other part of the process of opening the transmittal.
SE_STAT_CODE_FAILURE	and *transmittal_out_ptr is set to NULL, if dynamic binding is specified at compile time, but the shared library for the specified API implementation cannot be found, dynamic binding is specified at compile time, but the API implementation specified does not provide this function in its shared library, any problems not covered by the above are encountered while finding or opening the SEDRIS transmittal specified by the file_location parameter.