OSI/FTAM Programming Guide

NonStop FTAM Programming
HP NonStop OSI/FTAM Programming Guide—528612-001
3-40
NonStop FTAM Initiator Errors
The return value from a NonStop FTAM procedure call can be the first indication of an
error condition. NonStop FTAM procedures use two types of return values: status and
error. Status return values are returned by procedures performing I/O operations, and
error return values are returned by procedures that perform no I/O operations.
Status Return Values
The procedures that perform I/O operations (see Table 4-1 on page 4-2), including all
request procedures (procedures whose names end in “REQ_”) and the
FTM_CANCEL_RSP_ procedure, return status values. If the returned status value
(ZAPS-VAL-STATUS-xxx) does not equal ZAPS-VAL-STATUS-OK (0), the procedure
call failed to run successfully, and one of the remaining eight possible values tells you
what occurred and how to proceed. Table 3-3 lists all defined status values. In some
cases, a status value that is not reported to your application can appear in a trace; this
situation could arise if your program was stopped while the trace proceeded, or if
lower-level software recovered from the error condition for you.
Some values are rarely, if ever, returned to an application. The value
ZAPS-VAL-STATUS-EVENT is returned only on the APS_EVENT_RECEIVE_
procedure call. The values ZAPS-VAL-STATUS-RETRY-NOW,
ZAPS-VAL-STATUS-OPERATOR, and ZAPS-VAL-STATUS-UNKNOWN are not
returned to applications by the FTAM API. For more information on the values returned
programmatically, refer to the OSI/FTAM Programming Reference Manual.
If the status code indicates an error, more detailed status information is available to
your application. For status values not equal to ZAPS-VAL-STATUS-OK (0), to
receive the error-code, error-subcode, and original-error-info values, you should
Note. Guardian condition codes are not used with any of the FTAM procedures.
Table 3-3. Status Code Values
Constant
(ZAPS-VAL-STATUS-) Value Meaning
OK 0 Operation succeeded.
EVENT 1 You have received an event.
NO-RETRY 2 Operation failed; don’t retry.
RETRY-NOW 3 Operation failed; retry immediately.
RETRY-LATER 4 Operation failed; retry after a delay.
OPERATOR 5 Operation failed; get operator; fix problem and
retry later.
ABORT 6 Operation failed; abort association and
discard connection context.
DISCARD 7 Operation failed, and the association is lost;
discard connection context.
UNKNOWN 8 Operation failed; status unknown.