SQLDBC_Types.h File Reference


Detailed Description

Header file for basic types and macros.

Author:
DL SAP DB INTERFACES
See also:

Definition in file SQLDBC_Types.h.

Go to the source code of this file.

Defines

Typedefs

Enumerations


Define Documentation

#define CPP_BOOL_NOT_IMPLEMENTED

This macro has been defined for compilers to which the bool type is unknown, which is the case with Sun and some AIX compilers.

Definition at line 106 of file SQLDBC_Types.h.

#define SQLDBC_DATA_AT_EXEC   (-2)

Indicates that the data and length of the parameter will be known only at execution time.

Definition at line 227 of file SQLDBC_Types.h.

#define SQLDBC_DEFAULT_PARAM   (-5)

Flag indicating that the default parameter is to be used.

Definition at line 242 of file SQLDBC_Types.h.

#define SQLDBC_FALSE   ((SQLDBC_Bool)0)

false value for the SQLDBC_Bool type.

Definition at line 132 of file SQLDBC_Types.h.

#define SQLDBC_IGNORE   (-6)

Flag indicating that this parameter is to be ignored.

Definition at line 247 of file SQLDBC_Types.h.

#define SQLDBC_LEN_DATA_AT_EXEC ( length   )     (-(length)+SQLDBC_LEN_DATA_AT_EXEC_OFFSET)

Macro for late binding.

Parameters:
length The length that the parameter will have. This macro is currently unused.

Definition at line 260 of file SQLDBC_Types.h.

#define SQLDBC_LEN_DATA_AT_EXEC_OFFSET   (-100)

Offset for IFR_LEN_DATA_AT_EXEC.

Definition at line 253 of file SQLDBC_Types.h.

#define SQLDBC_NO_TOTAL   (-4)

Flag indicating that the SQLDBC cannot determine the total number of bytes.

Definition at line 237 of file SQLDBC_Types.h.

#define SQLDBC_NTS   (-3)

Indicator flag for the length of an zero-terminated string.

Definition at line 232 of file SQLDBC_Types.h.

#define SQLDBC_NULL_DATA   (-1)

Indicator of NULL data in input/output.

Definition at line 222 of file SQLDBC_Types.h.

#define SQLDBC_StringEncodingAscii   SQLDBC_StringEncodingType::Ascii

Plain 8-bit ASCII encoding (each byte stands for itself).

Definition at line 363 of file SQLDBC_Types.h.

#define SQLDBC_StringEncodingUCS2   SQLDBC_StringEncodingType::UCS2

UCS2 big-endian encoding.

Definition at line 369 of file SQLDBC_Types.h.

#define SQLDBC_StringEncodingUCS2Native   SQLDBC_StringEncodingType::UCS2

UCS2 little-endian encoding.

Definition at line 384 of file SQLDBC_Types.h.

#define SQLDBC_StringEncodingUCS2Swapped   SQLDBC_StringEncodingType::UCS2Swapped

UCS2 little-endian encoding.

Definition at line 375 of file SQLDBC_Types.h.

#define SQLDBC_StringEncodingUnknown   SQLDBC_StringEncodingType::Unknown

Unknown encoding (do not use).

Definition at line 357 of file SQLDBC_Types.h.

#define SQLDBC_StringEncodingUTF8   SQLDBC_StringEncodingType::UTF8

UTF8 encoding.

Definition at line 391 of file SQLDBC_Types.h.

#define SQLDBC_TRUE   ((SQLDBC_Bool)1)

true value for the SQLDBC_Bool type.

Definition at line 129 of file SQLDBC_Types.h.


Typedef Documentation

typedef unsigned char SQLDBC_Byte

Type definition for an unsigned-byte.

Definition at line 153 of file SQLDBC_Types.h.

typedef signed int SQLDBC_Int

Standard signed-integer type of the platform.

Definition at line 217 of file SQLDBC_Types.h.

typedef signed char SQLDBC_Int1

Signed 1-byte integer.

Definition at line 170 of file SQLDBC_Types.h.

typedef signed short SQLDBC_Int2

Signed 2-byte integer.

Definition at line 176 of file SQLDBC_Types.h.

typedef signed int SQLDBC_Int4

Signed 4-byte integer.

Definition at line 182 of file SQLDBC_Types.h.

typedef long long SQLDBC_Int8

Signed 8-byte integer.

Definition at line 197 of file SQLDBC_Types.h.

typedef SQLDBC_Int4 SQLDBC_Length

Type definition for the length of certain argument.

This type is used for indicator/length variables in parameter binding.

Definition at line 208 of file SQLDBC_Types.h.

typedef signed long SQLDBC_Long

A signed long type, which has 64-bit length on 64-bit platforms, and 32 bit length on 32-bit platforms.

Definition at line 147 of file SQLDBC_Types.h.

typedef SQLDBC_ULong SQLDBC_size_t

Type definition for a memory size (size_t).

Definition at line 158 of file SQLDBC_Types.h.

typedef unsigned int SQLDBC_UInt

Standard unsigned-integer type of the platform.

Definition at line 213 of file SQLDBC_Types.h.

typedef unsigned char SQLDBC_UInt1

Unsigned 1-byte integer.

Definition at line 167 of file SQLDBC_Types.h.

typedef unsigned short SQLDBC_UInt2

Unsigned 2-byte integer.

Definition at line 173 of file SQLDBC_Types.h.

typedef unsigned int SQLDBC_UInt4

Unsigned 4-byte integer.

Definition at line 179 of file SQLDBC_Types.h.

typedef unsigned long long SQLDBC_UInt8

Unsigned 8-byte integer.

Definition at line 194 of file SQLDBC_Types.h.

typedef unsigned long SQLDBC_ULong

An unsigned long type, which has 64-bit length on 64-bit platforms, and 32 bit length on 32-bit platforms.

Definition at line 142 of file SQLDBC_Types.h.

typedef SQLDBC_Byte SQLDBC_UTF8

Type definitions for an UTF8 character.

Definition at line 163 of file SQLDBC_Types.h.


Enumeration Type Documentation

enum SQLDBC_DateTimeFormat_Format

The possible date/time formats.

Enumerator:
SQLDBC_DateTimeFormat_Format_None_C  Unknown, not set.
SQLDBC_DateTimeFormat_Format_Normal_C  Normal (aka INTERNAL).
SQLDBC_DateTimeFormat_Format_Iso_C  ISO (ODBC, JDBC)
SQLDBC_DateTimeFormat_Format_Usa_C  USA
SQLDBC_DateTimeFormat_Format_Eur_C  Europe
SQLDBC_DateTimeFormat_Format_Jis_C  Japan
SQLDBC_DateTimeFormat_Format_OracleDate_C 
Deprecated:
Unused.
SQLDBC_DateTimeFormat_Format_WasAnsiNowIsSameAsIso_C 
Deprecated:
Unused
SQLDBC_DateTimeFormat_Format_TsEur_C 
Deprecated:
(same as Eur_C).

Definition at line 560 of file SQLDBC_Types.h.

enum SQLDBC_HostType

Types of host (native) variables.

Enumerator:
SQLDBC_HOSTTYPE_MIN  Minimum value for checks.
SQLDBC_HOSTTYPE_PARAMETER_NOTSET  The default value for unset parameters.
SQLDBC_HOSTTYPE_BINARY  Binary data, length must be provided. No conversion is applied.
SQLDBC_HOSTTYPE_ASCII  An zero-terminated ASCII string zero terminated.
SQLDBC_HOSTTYPE_UTF8  An zero-terminated UTF8 string.
SQLDBC_HOSTTYPE_UINT1  An unsigned 8-bit integer.
SQLDBC_HOSTTYPE_INT1  A signed 8-bit integer.
SQLDBC_HOSTTYPE_UINT2  An unsigned 16-bit integer.
SQLDBC_HOSTTYPE_INT2  A signed 16-bit integer.
SQLDBC_HOSTTYPE_UINT4  An unsigned 32-bit integer.
SQLDBC_HOSTTYPE_INT4  A signed 32-bit integer.
SQLDBC_HOSTTYPE_UINT8  An unsigned 64-bit integer.
SQLDBC_HOSTTYPE_INT8  A signed 64-bit integer.
SQLDBC_HOSTTYPE_DOUBLE  A double value.
SQLDBC_HOSTTYPE_FLOAT  A float value.
SQLDBC_HOSTTYPE_ODBCDATE  An ODBC SQL_DATE_STRUCT struct.
SQLDBC_HOSTTYPE_ODBCTIME  An ODBC SQL_TIME_STRUCT struct.
SQLDBC_HOSTTYPE_ODBCTIMESTAMP  An ODBC SQL_TIMESTAMP_STRUCT struct.
SQLDBC_HOSTTYPE_ODBCNUMERIC  An ODBC SQL_NUMERIC_STRUCT struct.
SQLDBC_HOSTTYPE_GUID  An GUID.
SQLDBC_HOSTTYPE_UCS2  An zero-terminated UCS2 string (in none swapped byte order ASCII 'A' is coded as '0x0041).
SQLDBC_HOSTTYPE_UCS2_SWAPPED  An zero-terminated UCS2 string (in swapped byte order ASCII 'A' is coded as 0x4100').
SQLDBC_HOSTTYPE_UCS2_NATIVE  An zero-terminated UCS2 string (in native byte order).
SQLDBC_HOSTTYPE_BLOB  Large binary object (pointer to LOB handle).
SQLDBC_HOSTTYPE_ASCII_CLOB  Large character object (pointer to LOB handle).
SQLDBC_HOSTTYPE_UTF8_CLOB  Large unicode character object (pointer to LOB handle).
SQLDBC_HOSTTYPE_UCS2_CLOB  Large unicode character object (pointer to LOB handle).
SQLDBC_HOSTTYPE_UCS2_SWAPPED_CLOB  Large unicode character object (pointer to LOB handle).
SQLDBC_HOSTTYPE_UCS2_NATIVE_CLOB 
SQLDBC_HOSTTYPE_STREAM  ABAP/OMS Stream.
SQLDBC_HOSTTYPE_RAWHEX  Hex dump of content in SQL hexadecimal literal format.
SQLDBC_HOSTTYPE_USERDEFINED  User-defined, must supply a parameter converter.
SQLDBC_HOSTTYPE_MAX  Maximum value for checks.

Definition at line 455 of file SQLDBC_Types.h.

enum SQLDBC_Retcode

Return code of functions.

This is not an error code, it only indicates the status of the function call.

Enumerator:
SQLDBC_INVALID_OBJECT  Application tries to use an invalid object reference.
SQLDBC_OK  Function call successful.
SQLDBC_NOT_OK  Function call not successful. Further information can be found in the corresponding error object.
SQLDBC_DATA_TRUNC  Data was truncated during the call.
SQLDBC_OVERFLOW  Signalizes a numeric overflow.
SQLDBC_SUCCESS_WITH_INFO  The method succeeded with warnings.
SQLDBC_NO_DATA_FOUND  Data was not found.
SQLDBC_NEED_DATA  Late binding, data is needed for execution.

Definition at line 268 of file SQLDBC_Types.h.

enum SQLDBC_Rowstatus

Row status for mass operations.

The status for an inserted row is either one of the first two constants, or the row count of the individual column. The other constants are defined for updatable row sets.

Enumerator:
SQLDBC_EXECUTE_FAILED  Execute of this row failed.
SQLDBC_SUCCESS_NO_INFO  Execute succeeded, no information about affected rows available,
SQLDBC_DELETED  affected rows deleted,
SQLDBC_UPDATED  affected rows updated,
SQLDBC_NOROW  affected rows not contained in result set,
SQLDBC_ADDED  affected rows inserted

Definition at line 293 of file SQLDBC_Types.h.

enum SQLDBC_SerialTag

Possible values for getting the last inserted keys.

Enumerator:
SQLDBC_FIRST_INSERTED_SERIAL  The first inserted key.
SQLDBC_LAST_INSERTED_SERIAL  The last inserted key.

Definition at line 579 of file SQLDBC_Types.h.

enum SQLDBC_SQLMode

possible SQL modes.

Enumerator:
SQLDBC_INTERNAL  SQL mode INTERNAL.
SQLDBC_ANSI 
Deprecated:
SQL mode ANSI.
SQLDBC_DB2 
Deprecated:
SQL mode DB2.
SQLDBC_ORACLE  SQL mode ORACLE.
SQLDBC_SAPR3  SQL mode used for SAP R/3

Definition at line 316 of file SQLDBC_Types.h.

enum SQLDBC_SQLType

Constants used for SQL data types.

These constants are delivered in the short infos of the database or provided by the application at parameter binding time.

Enumerator:
SQLDBC_SQLTYPE_MIN  Minimum value internally used for checks.
SQLDBC_SQLTYPE_FIXED  Data type FIXED.
SQLDBC_SQLTYPE_FLOAT  Data type FLOAT.
SQLDBC_SQLTYPE_CHA  Data type CHAR ASCII.
SQLDBC_SQLTYPE_CHE 
Deprecated:
Data type CHAR EBCDIC.
SQLDBC_SQLTYPE_CHB  Data type CHAR BYTE.
SQLDBC_SQLTYPE_ROWID 
Deprecated:
Internally used.
SQLDBC_SQLTYPE_STRA  Data type LONG ASCII.
SQLDBC_SQLTYPE_STRE 
Deprecated:
Data type LONG EBCDIC.
SQLDBC_SQLTYPE_STRB  Data type LONG BYTE.
SQLDBC_SQLTYPE_STRDB 
Deprecated:
Internally used.
SQLDBC_SQLTYPE_DATE  Data type DATE (SQL mode INTERNAL).
SQLDBC_SQLTYPE_TIME  Data type TIME (SQL mode INTERNAL).
SQLDBC_SQLTYPE_VFLOAT  Data type FLOAT (output of arithmetic expressions).
SQLDBC_SQLTYPE_TIMESTAMP  Data type TIMESTAMP (SQL mode INTERNAL), or DATE (SQL mode Oracle).
SQLDBC_SQLTYPE_UNKNOWN 
Deprecated:
Internally used.
SQLDBC_SQLTYPE_NUMBER 
Deprecated:
Internally used.
SQLDBC_SQLTYPE_NONUMBER 
Deprecated:
Internally used.
SQLDBC_SQLTYPE_DURATION 
Deprecated:
Internally used.
SQLDBC_SQLTYPE_DBYTEEBCDIC 
Deprecated:
Internally used.
SQLDBC_SQLTYPE_LONGA 
Deprecated:
Data type LONG ASCII.
SQLDBC_SQLTYPE_LONGE 
Deprecated:
Data type LONG EBCDIC.
SQLDBC_SQLTYPE_LONGB 
Deprecated:
Data type LONG BYTE.
SQLDBC_SQLTYPE_LONGDB 
Deprecated:
Internally used.
SQLDBC_SQLTYPE_BOOLEAN  Data type BOOLEAN.
SQLDBC_SQLTYPE_UNICODE  Data type CHAR UNICODE.
SQLDBC_SQLTYPE_DTFILLER1 
Deprecated:
Internally used.
SQLDBC_SQLTYPE_DTFILLER2 
Deprecated:
Internally used.
SQLDBC_SQLTYPE_DTFILLER3 
Deprecated:
Internally used.
SQLDBC_SQLTYPE_DTFILLER4 
Deprecated:
Internally used.
SQLDBC_SQLTYPE_SMALLINT  Data type SMALLINT.
SQLDBC_SQLTYPE_INTEGER  Data type INTEGER.
SQLDBC_SQLTYPE_VARCHARA  Data type VARCHAR ASCII.
SQLDBC_SQLTYPE_VARCHARE 
Deprecated:
Data type VARCHAR EBCDIC.
SQLDBC_SQLTYPE_VARCHARB  Data type VARCHAR BYTE.
SQLDBC_SQLTYPE_STRUNI  Data type LONG UNICODE.
SQLDBC_SQLTYPE_LONGUNI 
Deprecated:
Data type LONG UNICODE.
SQLDBC_SQLTYPE_VARCHARUNI  Data type VARCHAR UNICODE.
SQLDBC_SQLTYPE_UDT  Data type used for C++ Stored Procedures.
SQLDBC_SQLTYPE_ABAPTABHANDLE  Data type used for C++ Stored Procedures.
SQLDBC_SQLTYPE_DWYDE  Data type used for C++ Stored Procedures.
SQLDBC_SQLTYPE_MAX  Maximum value for checks.

Definition at line 399 of file SQLDBC_Types.h.

enum SQLDBC_SQLWarningCode

A list of all kinds of warnings that are supported by this interfaces.

Enumerator:
SQLDBC_SQLWARNING_DATA_TRUNCATED  Input or output data has been truncated.
SQLDBC_SQLWARNING_MAX  For checks.

Definition at line 526 of file SQLDBC_Types.h.

enum SQLDBC_StringEncodingType_Encoding

Enumerator:
SQLDBC_StringEncodingType_Encoding_Unknown 
SQLDBC_StringEncodingType_Encoding_Ascii 
SQLDBC_StringEncodingType_Encoding_UCS2 
SQLDBC_StringEncodingType_Encoding_UCS2Swapped 
SQLDBC_StringEncodingType_Encoding_UTF8 

Definition at line 344 of file SQLDBC_Types.h.