Api_rc

typedef struct Api_rc
{
Return_code   return_code; /* MAP errors */
Return_code   vendor_code; /* Optional Vendor defined errors */
} Api_rc;

Api_rc (Application Interface return_code) provides you with error information when a function fails. Every function has a parameter of this type, usually in its inout_dcb and usually defined as the result parameter.

return_code

Specifies the MAP 3.0 error that occurred. These errors are listed as defined FTExxx constants. Refer to the HP FTAM/9000 Reference Manual for a list of possible errors, their causes, and corrective actions.

A return_code value of SUCCESS (zero) indicates the request went through the application interface, ftam_init, and responder, and returned back to the user program. If the return_code value indicates an error (non-zero), the error could be detected in any one of these locations.
For synchronous calls, the function return value and return_code are always identical.
For asynchronous calls with a function return value of SUCCESS, the return_code indicates the success or failure of the call.
For asynchronous calls, the function return value and return_code are identical if the function return value of the original call is not SUCCESS.

vendor_code

Contains HP-UX vendor-specific error information that describes the error. Note, not all errors return vendor_codes.

The upper 16 bits contain the log instance.

The lower 16 bits define errors that are listed as defined FTVxxx constants. Refer to the HP FTAM/9000 Reference Manual for a list of possible vendor_codes, their causes, and corrective actions.

Api_rc

Technical documentation

» Table of Contents

» Glossary

» Index