Function Name: Open Transmittal By File

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_SUCCESS - and *transmittal_out_ptr is set to point to the SEDRIS 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_NULL_REQUIRED_PARAMETER - and *transmittal_out_ptr is left unaltered, if either the file_location or transmittal_out_ptr is NULL.

SE_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. It could also occur if the file location specified a non-local file and the API had no transport mechanism for accessing the remote file.

SE_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_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_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_FAILURE - and *transmittal_out_ptr is set to NULL, if

  1. dynamic binding is specified at compile time, but the shared library for the specified API implementation cannot be found,
  2. dynamic binding is specified at compile time, but the API implementation specified does not provide this function in its shared library,
  3. any problems not covered by the above are encountered while finding or opening the SEDRIS transmittal specified by the file_location parameter.

Prototype


extern SE_STATUS_CODE_ENUM
SE_OpenTransmittalByFile
(
constchar file_location[], (notes)
constchar implementation_identifier[], (notes)
SE_ACCESS_MODE_ENUM access_mode, (notes)
SE_TRANSMITTAL *transmittal_out_ptr (notes)
);

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.
Prev: Objects Are Same. Next: Open Transmittal By Name. Up:Index.