Overview of XLA Functions

XLA Function Return Codes

All of the XLA API functions described in this chapter return a value of type SQLRETURN.

SQLRETURN is defined by ODBC to have one of the following values:

SQL_SUCCESS
SQL_SUCCESS_WITH_INFO
SQL_NO_DATA_FOUND
SQL_ERROR

See XLA Error Handling.

Note:

SQL_NO_DATA_FOUND is defined in sqlext.h, which is included by timesten.h.

XLA Function Parameter Types (Input, Output, Input/Output)

There are three XLA function parameter types.

In the function descriptions:

All parameters are input-only unless otherwise indicated.
Output parameters are prefixed with OUT.
Input/output parameters are prefixed with IN OUT.

Results Output by XLA Functions

Most routines in this API copy results to application buffers. Those few routines that produce pointers to buffers containing results are guaranteed as valid only until the next call with the same XLA handle.

Exceptions to this rule include the following.

Buffers remain valid across calls to the ttXlaError function that supplies diagnostic information.
Results returned by ttXlaNextUpdate remain valid until the next call to ttXlaNextUpdate.
For ttXlaAcknowledge, if the application must retain access to the buffers for a longer time, it must copy the information from the buffer returned by XLA to an application-owned buffer.

Character string values in XLA are null-terminated, except for actual column values. Fixed-length CHAR columns are space-padded to their full length. VARCHAR columns have an explicit length encoded.

XLA uses the same data structures for 64-bit platforms as it has for 32-bit platforms. The types SQLUINTEGER and SQLUBIGINT refer to 64-bit and 32-bit integers unambiguously. Issues of alignment and padding are addressed by filling the type definition so that each SQLUINTEGER value is on a four-byte boundary and each SQLUBIGINT value is on an eight-byte boundary. For a description of storage requirements for other TimesTen data types, see Understanding Rows in Oracle TimesTen In-Memory Database Operations Guide.

XLA Function Required Privileges

Any XLA functionality requires the system privilege XLA.

XLA System Privilege introduces the effects of TimesTen access control features on XLA functionality.