|
|
|
The FairCom DB® function definitions are presented in alphabetical order, each starting on a new page, to facilitate your search for information.
Function definitions include some or all of the following sections:
Short Name
Internal FairCom DB function name. See Function Name Cross Reference for a cross-reference.
Type
ISAM, Low-Level, Server only, Server admin, threading, or utility function
Declaration
Function and parameter declarations
Description
Detailed description
Return
Explanation of most common return values. See FairCom DB Error Codes for additional error explanations.
Example
Programming example
Limitations
Restrictions on use and/or shortcomings
See also
Related functions and information
After each FairCom DB function call, a global variable will contain the current error code, or zero if no error occurred. In the case of all types except ISAM, the error code variable is uerr_cod. Some of the FairCom DB Low-Level functions also set the global variable sysiocod to the value of errno when a C runtime function experiences an I/O error. errno is the Language C run-time error variable automatically maintained by the C run-time library. Unlike uerr_cod, sysiocod is not reset by new calls to FairCom DB. It is only set to errno if an open, create, seek, read, write, or lock function fails. The FairCom DB ISAM functions set the variable isam_err. In addition, the ISAM functions set the variable isam_fil with the data or index file number involved.
The error codes listed in each Return section of the function descriptions are not exhaustive. The only error codes included are those which have a meaningful context for the function in question.
