ESQL/C header files

When you install HCL® OneDB® ESQL/C, the installation script stores the header files in the $ONEDB_HOME/incl/esql directory on a UNIX™ operating system and in the %ONEDB_HOME%\incl\esql directory in a Windows™ environment.

The following table shows the header files provided with the product.
Table 1. ESQL/C header files
Header file Contains Additional information
datetime.h Definitions of the datetime and interval structures, which are the host variables for DATETIME and INTERVAL columns Time data types
decimal.h Definition of the decimal data type, which is the host variable for DECIMAL and MONEY data types Numeric data types
gls.h Function prototypes and data structures for the GLS functionality HCL OneDB GLS User's Guide
ifxtypes.h Correctly maps the HCL OneDB data types int1, int2, int4, mint, mlong, MSHORT, and MCHAR for 32-bit and 64-bit platforms The integer host variable types
locator.h Definition of the locator structure (ifx_loc_t or loc_t), which is the host variable for byte and text columns Simple large objects
sqlca.h Definition of the structure that ESQL/C uses to store error-status codes

The esql preprocessor automatically includes this file when it preprocesses your program.

 Exception handling
sqlda.h Structure definition for value pointers and descriptions of dynamically defined variables Determine SQL statements
sqlhdr.h This file includes the sqlda.h header file, other header files, and function prototypes.

The preprocessor automatically includes this file when it preprocesses your program.

 Header files included in your program
sqliapi.h Function prototypes for internal library APIs

For internal use only.

 None
sqlstype.h Definitions of constants for SQL statements

The DESCRIBE statement uses these constants to describe a dynamically prepared SQL statement.

 Determine SQL statements
sqltypes.h Defines constants that correspond to ESQL/C and SQL data types

ESQL/C uses these constants when your program contains a DESCRIBE statement.

 Data type constants
sqlxtype.h Defines constants that correspond to and SQL data types when you are in X/Open mode

ESQL/C uses these constants when your program contains a DESCRIBE statement.

 X/Open data type constants
value.h Value structures that uses

For internal use only.

 None
varchar.h Macros that you can use with the VARCHAR data type Character and string data types
The following figure shows the header files specific to HCL OneDB.
Table 2. ESQL/C header files for HCL OneDB
Header file Contents Additional information
collct.h Definitions of data structures for complex types in Complex data types
ifxgls.h Function prototypes for the GLS application programming interface

For internal use only.

 None
int8.h Definition of the structure that stores the INT8 data type The int8 data type
The following table shows the header files specific to Windows environments.
Table 3. ESQL/C header files for Windows environments
Header file Contents Additional information
sqlproto.h Function prototypes of all ESQL/C library functions for use with source that is not fully ANSI C compliant Declare function prototypes
infxcexp.c Contains the C code to export the addresses of all C runtime routines that the ESQL client-interface DLL uses Same runtime routines for version independence
login.h The definition of the InetLogin and HostInfoStruct structures, which enable you to customize configuration information for the application

Because this file does not contain ESQL statements, you do not need to include it with the ESQL include directive. Use instead the C #include preprocessor directive.

 Fields of the InetLogin structure