Each function description contains the following sections:
- Purpose
- This section gives a brief overview of what the function does. It also
indicates if any functions should be called before and after calling the function
being described.
Each function also has a table that indicates to which
specification or standard the function conforms.
This table indicates
support of the function. Some functions use a set of options that do not apply
to all specifications or standards. Any significant differences are identified
in the restrictions section for the function.
- Syntax
- This section contains the generic 'C' prototype. The generic prototype
is used for all environments, including Windows.
All function
arguments that are pointers are defined using the macro FAR, this
macro is defined out (set to a blank) for all platforms except Windows. On
Windows FAR is used to define pointer arguments as far pointers.
- Arguments
- This section lists each function argument, along with its data type,
a description, and whether it is an input or output argument.
Some functions contain input or output arguments, which are known as deferred or bound arguments.
These arguments
are pointers to buffers allocated by the application, and are associated with
(or bound to) either a parameter in an SQL statement, or a column in a result
set. The data areas specified by the function are accessed by DB2 CLI at a later
time. These deferred data areas must still be valid at the time DB2 CLI accesses
them.
- Usage
- This section provides information about how to use the function and
any special considerations. Possible error conditions are not discussed here,
but are listed in the diagnostics section instead.
- Return codes
- This section lists all the possible function return codes. When SQL_ERROR
or SQL_SUCCESS_WITH_INFO is returned, error information can be obtained by
calling SQLError() or SQLGetDiagRec().
- Diagnostics
- This section contains a table that lists the SQLSTATEs explicitly returned
by DB2 CLI (SQLSTATEs generated by the DBMS might also be returned) and indicates
the cause of the error. These values are obtained by calling SQLError() or SQLGetDiagRec() after the function returns an SQL_ERROR
or SQL_SUCCESS_WITH_INFO.
- Restrictions
- This section indicates any differences or limitations between DB2 Everyplace CLI
and ODBC that might affect an application.
See the IBM DB2 Universal Database Call Level Interface Guide and Reference for more information about DB2 CLI, including information
about return codes, diagnostics, examples, setting up the CLI environment,
and accessing the sample applications.
Related reference