Enumerant | Definition | Value |
SE_STATCODE_SUCCESS |
To be returned when all parameters are valid and all operations
succeeded, as a general statement. SE_STATCODE_SUCCESS always indicates
that the function succeeded.
However, see individual functions for details, since some of the
other status codes do not necessarily indicate error conditions
(for example, SE_STATCODE_NO_OBJECT,
SE_STATCODE_DIFFERENT_TRANSMITTAL)
In other words, a function may return something other than
SE_STATCODE_SUCCESS, without encountering an error condition. (See
SE_GetNextObject(), for example.)
|
1 |
SE_STATCODE_DELETED_OBJECT |
To be returned by a function when an argument of type SE_Object
has been removed from its transmittal.
|
2 |
SE_STATCODE_DIFFERENT_TRANSMITTAL |
To be returned when the caller passed in valid parameters
to the given function, and one or more objects were encountered
that were in a different transmittal than the start object.
Note that this status is *not* an error condition when
extracting objects, but *is* an error condition when
attempting to remove objects from a transmittal.
|
3 |
SE_STATCODE_INVALID_ACCESS_MODE |
To be returned by a function (for example SE_OpenTransmittalByLocation())
if the resolved file location of a transmittal 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
(1) the access mode specified was create or update and the
file was marked read-only, or
(2) no access was permitted for the account running the
application, or
(3) create or update mode was requested but the API
implementation did not support the write capability
(for example when linked to a read-only s1000-SEDRIS API
implementation).
(4) a function requiring create or update mode was invoked
for an object in a transmittal that was opened in
read-only mode, for example attempting to remove an object
from a read-only transmittal.
|
4 |
SE_STATCODE_INVALID_OBJECT_LABEL |
To be returned when the caller has provided as a function
argument a label that is not valid in accordance with label
syntax rules (i.e. the same lexical conventions that apply
to the name of a variable in ANSI C), or when an attempt
is made to publish an object with a label that is already
in use.
|
5 |
SE_STATCODE_INVALID_TRANSMITTAL_NAME |
To be returned when a parameter representing a transmittal name
did not specify a name that was valid according to the formal
SEDRIS namespace. See SE_ResolveTransmittalName()'s description
for a description of the validation done.
|
6 |
SE_STATCODE_NO_OBJECT |
To be returned by SE_GetNextObject(), the 1-shot functions,
etc. when there are no objects left to return that meet the
specified criteria.
|
7 |
SE_STATCODE_SRF_OPERATION_UNSUPPORTED |
|
8 |
SE_STATCODE_TRANSMITTAL_INACCESSIBLE |
To be returned by the open-transmittal functions (for example
SE_OpenTransmittalByLocation()) if the resolved 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.
|
9 |
SE_STATCODE_UNPUBLISHED_OBJECT |
To be returned when an object is encountered (while
attempting to process an intertransmittal reference)
that is not published by its its transmittal.
(To be available for intertransmittal referencing,
an object must be published.)
|
10 |
SE_STATCODE_UNRESOLVED_TRANSMITTAL |
To be returned when a reference to a transmittal is encountered
that cannot be resolved.
|
11 |
SE_STATCODE_UNRESOLVED_INPUT_OBJECT |
To be returned when the caller has provided as a function
argument an unresolved object, for example as the start object
for an iterator.
Note that this status *is* an error condition, returned
when the API must be able to access the content of the
unresolved object in order to perform the requested
operation.
|
12 |
SE_STATCODE_UNRESOLVED_OUTPUT_OBJECT |
To be returned when an SE_Object handle is encountered that
references a DRM object that is not available to the
SEDRIS API, i.e., the DRM object is contained within a
transmittal whose content the API cannot access or the
application programmer has chosen to not to access that
content.
Note that this status is not necessarily an error condition.
See the individual functions that can return this status
for further details.
|
13 |
SE_STATCODE_UNSUPPORTED_ENCODING |
To be returned by the open-transmittal functions (for example
SE_OpenTransmittalByLocation()) when a transmittal was requested
in a format that is not supported by the implementation(s)
of the SEDRIS API linked to the application.
|
14 |
SE_STATCODE_INACTIONABLE_FAILURE |
This code indicates a general, unknown, or other error for
which there is no meaningful branch that the application code
could make. (The error description may contain more detailed
information.)
|
1000 |
SE_STATCODE_OUT_OF_MEMORY |
To be returned when the API is out of memory.
|
1001 |
SE_STATCODE_C_ENUMERATION_VALUE_INVALID |
|
2401 |
SE_STATCODE_C_STORE_INVALID |
|
2402 |