c-tree Plus Function Descriptions

The c-tree Plus® function definitions are presented in alphabetical order, each starting on a new page, to facilitate your search for information.

Function definitions are comprised some or all of the following sections:

Short Name

Internal c-tree Plus function name. See “Function Name Cross Reference” in the c-tree Plus Programmer’s Reference Guide 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 “c-tree Plus Error Codes” in the c-tree Plus Programmer’s Reference Guide for additional error explanations.

Example

Programming example

Limitations

Restrictions on use and/or shortcomings

See also

Related functions and information

After each c-tree Plus 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 c-tree Plus 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 c-tree Plus. It is only set to errno if an open, create, seek, read, write, or lock function fails. The c-tree Plus 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.