OAERROR
oaerror returns the error message that corresponds to the error number
contained in element 1 of the status array. Error numbers and messages
are contained the in OAGLOBAL environment file.
- If an application cannot access the OAGLOBAL environment file, the
message buffer will contain the message "Global Environment File
is not accessible. Unable to translate Error nnnnn."
- oaerror can also return messages for warnings, contained in element
2 of the status array. To obtain a warning message call oaerror with
the WARN option.
- To limit the length of the message buffer, call oaerror with the MAXLEN=n
option. The default length is 80 bytes. The maximum length is 256 bytes.
Syntax
status -- The Status Array.
The status array structure is passed by reference. It should
not be modified from when it is returned by an OmniAccess
routine, to when it is passed to oaerror for interpretation.
options -- Determines what
will be returned to the message buffer. Options is a character
value passed by reference, and terminated by a semicolon or
a null character.
message -- Is a character
value, passed by reference, that returns the message corresponding
to the error number contained in status element 1, or the
warning number contained in status element 2.
Options
ERROR -- causes the message
buffer to return a message that corresponds to the status.error
value (element 1). This is the default.
WARN -- causes the message
buffer to return a message that corresponds to the status.warn
value (element 2).
MAXLEN=n -- sets the length
of the message buffer to n bytes. The default length is 80
bytes. The maximum length is 256 bytes.
Example
Top
|
