Home
Client APIs and tools
You can use the HCL Informix® implementation of client APIs to develop applications for Informix database servers.
Informix® ODBC Driver Guide
The Informix® ODBC Driver Programmer's Manual serves as a user guide and reference for Informix ODBC Driver, which is the Informix implementation of the Microsoft™ Open Database Connectivity (ODBC) interface, Version 3.0.
Error messages
These topics describe the Informix® ODBC Driver error messages.
Map Informix® error messages to SQLSTATE values
The rest of this section describes diagnostic SQLSTATE values for Informix® ODBC Driver functions.
SQLAllocEnv (core level only)
SQLAllocEnv allocates memory for an environment handle and initializes the driver call level interface for application use.

Client APIs and tools
You can use the HCL Informix® implementation of client APIs to develop applications for Informix database servers.
- Change Data Capture API Programmer's Guide
  The Informix® Change Data Capture API Programmer's Guide describes how to program applications to process changed data from HCL Informix databases using the Informix Change Data Capture API.
- Embedded SQLJ for HCL Informix®
  The Informix® Embedded SQLJ User's Guide contains information about using Informix Embedded SQLJ.
- ESQL/C Guide
  The Informix® ESQL/C Programmer's Manual explains how to use Informix ESQL/C, the Informix implementation of Embedded Structured Query Language (SQL) for C (ESQL/C), to create client applications with database-management capabilities.
- GLS User's Guide
  The Informix® GLS User's Guide describes the Global Language Support (GLS) feature available in Informix products.
- API
  The Informix® GLS API Programmer's Guide describes the global language support (GLS) application programming interface (API) available in Informix ESQL/C and HCL Informix DataBlade® modules.
- Informix® Object Interface for C++ Guide
  The Informix® Object Interface for C++ Programmer's Guide describes how to develop HCL Informix client applications by using the object-oriented C++ programming language.
- Informix® ODBC Driver Guide
  The Informix® ODBC Driver Programmer's Manual serves as a user guide and reference for Informix ODBC Driver, which is the Informix implementation of the Microsoft™ Open Database Connectivity (ODBC) interface, Version 3.0.
  - Overview of HCL Informix® ODBC Driver
    These topics introduce the Informix® ODBC Driver and describe its advantages and architecture. The topics also describe conformance, isolation and lock levels, libraries, and environment variables.
  - Configure data sources
    These topics explain how to configure a data source (DSN) on UNIX™ and Windows™ for Informix® ODBC Driver.
  - Data types
    These topics contain information about the data types that are supported by Informix® ODBC Driver.
  - Smart large objects
    These topics describe how to store, create, and access a smart large object; how to transfer smart-large-object data; how to retrieve the status of a smart large object; and how to read or write a smart large object to or from a file.
  - Rows and collections
    Rows and collections are composite values that consist of one or more elements.
  - Client functions
    These topics describe the Informix® ODBC Driver client functions. Use these functions to access and manipulate smart large objects and rows and collections.
  - Application tracking in ODBC
    Set the CLIENT_LABEL environment variable in CSDK 4.50.xC4 onwards to assign a character string to ODBC client session and identify that character string on the database server. You can use this variable to distinguish one database session from the other.
  - Improve application performance
    These topics suggest ways to improve performance of Informix® ODBC Driver applications.
  - Error messages
    These topics describe the Informix® ODBC Driver error messages.
    - Diagnostic SQLSTATE values
      Each Informix® ODBC Driver function can return an SQLSTATE value that corresponds to the Informix error code.
    - Map SQLSTATE values to Informix® error messages
      View the SQLSTATE values that Informix® ODBC Driver can return.
    - Map Informix® error messages to SQLSTATE values
      The rest of this section describes diagnostic SQLSTATE values for Informix® ODBC Driver functions.
      - Deprecated and new HCL Informix® ODBC Driver APIs
        In , numerous ODBC APIs have been deprecated and their functionality transferred to new APIs.
      - SQLAllocConnect (core level only)
        This table describes the SQLSTATE and error values for SQLAllocConnect.
      - SQLAllocEnv (core level only)
        SQLAllocEnv allocates memory for an environment handle and initializes the driver call level interface for application use.
      - SQLAllocStmt (core level only)
        SQLAllocStmt allocates memory for a statement handle and associates the statement handle with the connection that hdbc specifies.
      - SQLBindCol (core level only)
        SQLBindCol assigns the storage and Informix® ODBC Driver C data type for a column in a result set.
      - SQLBindParameter (level one only)
        SQLBindParameter binds a buffer to a parameter marker in an SQL statement.
      - SQLBrowseConnect (level two only)
        SQLBrowseConnect supports an iterative method of discovering and enumerating the attributes and attribute values required to connect to a data source.
      - SQLCancel (core level only)
        SQLCancel cancels the processing on an hstmt or a query.
      - SQLColAttributes (core level only)
        SQLColAttributes returns descriptor information for a column in a result set.
      - SQLColumnPrivileges (level two only)
        SQLColumnPrivileges returns a list of columns and associated privileges for the specified table. The driver returns the information as a result set on the specified hstmt.
      - SQLColumns (level one only)
        SQLColumns returns the list of column names in specified tables. The driver returns this information as a result set on the specified hstmt.
      - SQLConnect (core level only)
        SQLConnect loads a driver and establishes a connection to a data source.
      - SQLDataSources (level two only)
        SQLDataSources lists data-source names.
      - SQLDescribeCol (core level only)
        SQLDescribeCol returns the result descriptor (column name, type, precision, scale, and whether it can have a NULL value) for one column in the result set.
      - SQLDisconnect
        SQLDisconnect closes the connection associated with a specific connection handle.
      - SQLDriverConnect (level one only)
        SQLDriverConnect is an alternative to SQLConnect.
      - SQLDrivers (level two only)
        SQLDrivers lists driver descriptions and driver-attribute keywords.
      - SQLError (core level only)
        SQLError returns error or status information.
      - SQLExecDirect (core level only)
        SQLExecDirect executes a preparable statement by using the current values of the parameter-marker variables if any parameters exist in the statement.
      - SQLExecute (core level only)
        SQLExecute executes a prepared statement by using the current values of the parameter-marker variables if any parameter markers exist in the statement.
      - SQLExtendedFetch (level two only)
        SQLExtendedFetch extends the functionality of SQLFetch.
      - SQLFetch (core level only)
        SQLFetch fetches a row of data from a result set.
      - SQLForeignKeys (level two only)
        SQLForeignKeys can return a list of foreign keys.
      - SQLFreeConnect (core level only)
        SQLFreeConnect releases a connection handle and frees all memory associated with the handle.
      - SQLFreeEnv (core level only)
        SQLFreeEnv frees the environment handle and releases all memory associated with the environment handle.
      - SQLFreeStmt (core level only)
        SQLFreeStmt stops the processing that is associated with a specific hstmt, closes any open cursors that are associated with the hstmt, discards pending results, and, optionally, frees all resources associated with the statement handle.
      - SQLGetConnectOption (level one only)
        SQLGetConnectOption returns the current setting of a connection option.
      - SQLGetCursorName (core level only)
        SQLGetCursorName returns the cursor name associated with a specified hstmt.
      - SQLGetData (level one only)
        SQLGetData returns result data for a single unbound column in the current row.
      - SQLGetFunctions (level one only)
        SQLGetFunctions returns information about whether the driver supports a specific function.
      - SQLGetInfo (level one only)
        SQLGetInfo returns general information about the driver and data source associated with an hdbc.
      - SQLGetStmtOption (level one only)
        SQLGetStmtOption returns the current setting of a statement option.
      - SQLGetTypeInfo (level one only)
        SQLGetTypeInfo returns information about data types that the data source supports.
      - SQLMoreResults (level two only)
        SQLMoreResults determines whether more results are available on an hstmt that contains SELECT, UPDATE, INSERT, or DELETE statements and, if so, initializes processing for those results.
      - SQLNativeSql (level two only)
        SQLNativeSql returns the SQL string that the driver translates.
      - SQLNumParams (level two only)
        SQLNumParams returns the number of parameters in an SQL statement.
      - SQLNumResultCols (core level only)
        SQLNumResultCols returns the number of columns in a result set.
      - SQLParamData (level one only)
        SQLParamData is used with SQLPutData to supply parameter data when a statement executes.
    - SQLParamOptions (core and level two only)
      SQLParamOptions allows an application to specify multiple values for the set of parameters assigned by SQLBindParameter.
  - Unicode
    These topics provide a brief overview of the Unicode standard and shows how it is used within ODBC applications.
  - ODBC Smart trigger
- .NET provider options
  The Data Server Provider for .NET DB2® provider option is the preferred Informix® provider for developing new applications.
- Informix® JDBC Driver Guide
  The Informix® JDBC Driver Programmer's Guide describes how to install, load, and use Informix JDBC Driver to connect to the Informix database from within a Java™ application or applet.
- Informix International Language Supplement (ILS) User Guide
  These topics include information about the translated user interface files for Informix® UNIX™ products, locales, and code set conversion tables
- Informix® OLE DB Provider Guide
  The Informix® OLE DB Provider Programmer's Guide describes the software requirements for using Informix OLE DB Provider, show how to install and configure the provider for your use, and explain how to use Informix OLE DB Provider to enable client applications, such as ActiveX Data Object (ADO) applications and web pages, to access data on the Informix server.

SQLAllocEnv (core level only)

SQLAllocEnv allocates memory for an environment handle and initializes the driver call level interface for application use.

An application must call SQLAllocEnv before it calls any other driver function.

A driver cannot return SQLSTATE values directly after the call to SQLAllocEnv because no valid handle exists with which to call SQLError.

Two levels of SQLAllocEnv functions exist, one within the driver manager (if you are using one) and one within the driver. The driver manager does not call the driver-level function until the application calls SQLConnect, SQLBrowseConnect, or SQLDriverConnect. If an error occurs in the driver-level SQLAllocEnv function, the driver manager-level SQLConnect, SQLBrowseConnect, or SQLDriverConnect function returns SQL_ERROR. A subsequent call to SQLError with henv, SQL_NULL_HDBC, and SQL_NULL_HSTMT returns SQLSTATE IM004 (the driver SQLAllocEnv function failed), followed by one of the following errors from the driver:

SQLSTATE S1000 (General error)
The Informix® ODBC Driver SQLSTATE value, which ranges from S1000 to S19ZZ.
For example, SQLSTATE S1001 (Memory-allocation failure) indicates that the call from the driver manager to the driver-level SQLAllocEnv returned SQL_ERROR, and the henv from the driver manager was set to SQL_NULL_HENV.