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

• #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.
  

• #define SQLDBC_TRUE   ((SQLDBC_Bool)1)

  true value for the SQLDBC_Bool type.
  

• #define SQLDBC_FALSE   ((SQLDBC_Bool)0)

  false value for the SQLDBC_Bool type.
  

• #define SQLDBC_NULL_DATA   (-1)

  Indicator of NULL data in input/output.
  

• #define SQLDBC_DATA_AT_EXEC   (-2)

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

• #define SQLDBC_NTS   (-3)

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

• #define SQLDBC_NO_TOTAL   (-4)

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

• #define SQLDBC_DEFAULT_PARAM   (-5)

  Flag indicating that the default parameter is to be used.
  

• #define SQLDBC_IGNORE   (-6)

  Flag indicating that this parameter is to be ignored.
  

• #define SQLDBC_LOB_KEEPALIVE   (-7)

  Flag indicating that the LOB fetched using this as indicator value shall be kept until transaction end.
  

• #define SQLDBC_LEN_DATA_AT_EXEC_OFFSET   (-100)

  Offset for IFR_LEN_DATA_AT_EXEC.
  

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

  Macro for late binding.
  

• #define SQLDBC_LEN_DECIMAL(digits, fraction)   (0x40000000 | ((digits & 0xFF) << 8) | (fraction & 0xFF))

  Macro for decimal binding.
  

• #define SQLDBC_DECIMAL_LENGTH(digits, fraction)   ((digits + 2) / 2)

  Macro for length of decimal number.
  

• #define SQLDBC_DECIMAL_DIGITS(indicator)

  Macro for extracting the number of digits of an indicator value.
  

• #define SQLDBC_DECIMAL_FRACTION(indicator)

  Macro for extracting the number of digits of an indicator value.
  

• #define SQLDBC_StringEncodingUnknown   SQLDBC_StringEncodingType::Unknown

  Unknown encoding (do not use).
  

• #define SQLDBC_StringEncodingAscii   SQLDBC_StringEncodingType::Ascii

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

• #define SQLDBC_StringEncodingUCS2   SQLDBC_StringEncodingType::UCS2

  UCS2 big-endian encoding.
  

• #define SQLDBC_StringEncodingUCS2Swapped   SQLDBC_StringEncodingType::UCS2Swapped

  UCS2 little-endian encoding.
  

• #define SQLDBC_StringEncodingUCS2Native   SQLDBC_StringEncodingType::UCS2

  UCS2 little-endian encoding.
  

• #define SQLDBC_StringEncodingUTF8   SQLDBC_StringEncodingType::UTF8

  UTF8 encoding.
  

Typedefs

• 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.
  

• 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.
  

• typedef unsigned char SQLDBC_Byte

  Type definition for an unsigned-byte.
  

• typedef SQLDBC_ULong SQLDBC_size_t

  Type definition for a memory size (size_t).
  

• typedef SQLDBC_Byte SQLDBC_UTF8

  Type definitions for an UTF8 character.
  

• typedef unsigned char SQLDBC_UInt1

  Unsigned 1-byte integer.
  

• typedef signed char SQLDBC_Int1

  Signed 1-byte integer.
  

• typedef unsigned short SQLDBC_UInt2

  Unsigned 2-byte integer.
  

• typedef signed short SQLDBC_Int2

  Signed 2-byte integer.
  

• typedef unsigned int SQLDBC_UInt4

  Unsigned 4-byte integer.
  

• typedef signed int SQLDBC_Int4

  Signed 4-byte integer.
  

• typedef unsigned long long SQLDBC_UInt8

  Unsigned 8-byte integer.
  

• typedef long long SQLDBC_Int8

  Signed 8-byte integer.
  

• typedef SQLDBC_Int4 SQLDBC_Length

  Type definition for the length of certain argument.
  

• typedef unsigned int SQLDBC_UInt

  Standard unsigned-integer type of the platform.
  

• typedef signed int SQLDBC_Int

  Standard signed-integer type of the platform.
  

• typedef unsigned char SQLDBC_DecFloat

  Type definition for a decfloat value.
  

• typedef enum SQLDBC_Retcode SQLDBC_Retcode

  Return code of functions.
  

• typedef enum SQLDBC_Rowstatus SQLDBC_Rowstatus

  Row status for mass operations.
  

• typedef enum SQLDBC_SQLMode SQLDBC_SQLMode

  possible SQL modes.
  

• typedef enum SQLDBC_StringEncodingType_Encoding SQLDBC_StringEncodingType_Encoding
• typedef enum SQLDBC_SQLType SQLDBC_SQLType

  Constants used for SQL data types.
  

• typedef enum SQLDBC_HostType SQLDBC_HostType

  Types of host (native) variables.
  

• typedef enum SQLDBC_SQLWarningCode SQLDBC_SQLWarningCode

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

• typedef enum SQLDBC_DateTimeFormat_Format SQLDBC_DateTimeFormat_Format

  The possible date/time formats.
  

• typedef enum SQLDBC_SerialTag SQLDBC_SerialTag

  Possible values for getting the last inserted keys.
  

• typedef enum SQLDBC_ProfileCountValues SQLDBC_ProfileCountValues

  Possible profile counters.
  

Enumerations

• enum SQLDBC_Retcode {
    SQLDBC_INVALID_OBJECT = -10909,
    SQLDBC_OK = 0,
    SQLDBC_NOT_OK = 1,
    SQLDBC_DATA_TRUNC = 2,
    SQLDBC_OVERFLOW = 3,
    SQLDBC_SUCCESS_WITH_INFO = 4,
    SQLDBC_NO_DATA_FOUND = 100,
    SQLDBC_NEED_DATA = 99
  }

  Return code of functions. More...
  

• enum SQLDBC_Rowstatus {
    SQLDBC_EXECUTE_FAILED = -2,
    SQLDBC_SUCCESS_NO_INFO = -3,
    SQLDBC_DELETED = -4,
    SQLDBC_UPDATED = -5,
    SQLDBC_NOROW = -6,
    SQLDBC_ADDED = -7,
    SQLDBC_ROW_IGNORE = -8
  }

  Row status for mass operations. More...
  

• enum SQLDBC_SQLMode {
    SQLDBC_INTERNAL = 2,
    SQLDBC_ANSI = 3,
    SQLDBC_DB2 = 4,
    SQLDBC_ORACLE = 5,
    SQLDBC_SAPR3 = 6
  }

  possible SQL modes. More...
  

• enum SQLDBC_StringEncodingType_Encoding {
    SQLDBC_StringEncodingType_Encoding_Unknown = 0,
    SQLDBC_StringEncodingType_Encoding_Ascii = 1,
    SQLDBC_StringEncodingType_Encoding_UCS2 = 2,
    SQLDBC_StringEncodingType_Encoding_UCS2Swapped = 3,
    SQLDBC_StringEncodingType_Encoding_UTF8 = 4
  }
• enum SQLDBC_SQLType {
    SQLDBC_SQLTYPE_MIN = 0,
    SQLDBC_SQLTYPE_FIXED = SQLDBC_SQLTYPE_MIN,
    SQLDBC_SQLTYPE_FLOAT = 1,
    SQLDBC_SQLTYPE_CHA = 2,
    SQLDBC_SQLTYPE_CHE = 3,
    SQLDBC_SQLTYPE_CHB = 4,
    SQLDBC_SQLTYPE_ROWID = 5,
    SQLDBC_SQLTYPE_STRA = 6,
    SQLDBC_SQLTYPE_STRE = 7,
    SQLDBC_SQLTYPE_STRB = 8,
    SQLDBC_SQLTYPE_STRDB = 9,
    SQLDBC_SQLTYPE_DATE = 10,
    SQLDBC_SQLTYPE_TIME = 11,
    SQLDBC_SQLTYPE_VFLOAT = 12,
    SQLDBC_SQLTYPE_TIMESTAMP = 13,
    SQLDBC_SQLTYPE_UNKNOWN = 14,
    SQLDBC_SQLTYPE_NUMBER = 15,
    SQLDBC_SQLTYPE_NONUMBER = 16,
    SQLDBC_SQLTYPE_DURATION = 17,
    SQLDBC_SQLTYPE_DBYTEEBCDIC = 18,
    SQLDBC_SQLTYPE_LONGA = 19,
    SQLDBC_SQLTYPE_LONGE = 20,
    SQLDBC_SQLTYPE_LONGB = 21,
    SQLDBC_SQLTYPE_LONGDB = 22,
    SQLDBC_SQLTYPE_BOOLEAN = 23,
    SQLDBC_SQLTYPE_UNICODE = 24,
    SQLDBC_SQLTYPE_DTFILLER1 = 25,
    SQLDBC_SQLTYPE_DTFILLER2 = 26,
    SQLDBC_SQLTYPE_DTFILLER3 = 27,
    SQLDBC_SQLTYPE_VOID = 27,
    SQLDBC_SQLTYPE_DTFILLER4 = 28,
    SQLDBC_SQLTYPE_SMALLINT = 29,
    SQLDBC_SQLTYPE_INTEGER = 30,
    SQLDBC_SQLTYPE_VARCHARA = 31,
    SQLDBC_SQLTYPE_VARCHARE = 32,
    SQLDBC_SQLTYPE_VARCHARB = 33,
    SQLDBC_SQLTYPE_STRUNI = 34,
    SQLDBC_SQLTYPE_LONGUNI = 35,
    SQLDBC_SQLTYPE_VARCHARUNI = 36,
    SQLDBC_SQLTYPE_UDT = 37,
    SQLDBC_SQLTYPE_ABAPTABHANDLE = 38,
    SQLDBC_SQLTYPE_DWYDE = 39,
    SQLDBC_SQLTYPE_MAX = SQLDBC_SQLTYPE_DWYDE
  }

  Constants used for SQL data types. More...
  

• enum SQLDBC_HostType {
    SQLDBC_HOSTTYPE_MIN = 0,
    SQLDBC_HOSTTYPE_PARAMETER_NOTSET = 0,
    SQLDBC_HOSTTYPE_BINARY = 1,
    SQLDBC_HOSTTYPE_ASCII = 2,
    SQLDBC_HOSTTYPE_UTF8 = 4,
    SQLDBC_HOSTTYPE_UINT1 = 5,
    SQLDBC_HOSTTYPE_INT1 = 6,
    SQLDBC_HOSTTYPE_UINT2 = 7,
    SQLDBC_HOSTTYPE_INT2 = 8,
    SQLDBC_HOSTTYPE_UINT4 = 9,
    SQLDBC_HOSTTYPE_INT4 = 10,
    SQLDBC_HOSTTYPE_UINT8 = 11,
    SQLDBC_HOSTTYPE_INT8 = 12,
    SQLDBC_HOSTTYPE_DOUBLE = 13,
    SQLDBC_HOSTTYPE_FLOAT = 14,
    SQLDBC_HOSTTYPE_ODBCDATE = 15,
    SQLDBC_HOSTTYPE_ODBCTIME = 16,
    SQLDBC_HOSTTYPE_ODBCTIMESTAMP = 17,
    SQLDBC_HOSTTYPE_ODBCNUMERIC = 18,
    SQLDBC_HOSTTYPE_GUID = 19,
    SQLDBC_HOSTTYPE_UCS2 = 20,
    SQLDBC_HOSTTYPE_UCS2_SWAPPED = 21,
    SQLDBC_HOSTTYPE_UCS2_NATIVE = SQLDBC_HOSTTYPE_UCS2,
    SQLDBC_HOSTTYPE_BLOB = 22,
    SQLDBC_HOSTTYPE_ASCII_CLOB = 23,
    SQLDBC_HOSTTYPE_UTF8_CLOB = 24,
    SQLDBC_HOSTTYPE_UCS2_CLOB = 25,
    SQLDBC_HOSTTYPE_UCS2_SWAPPED_CLOB = 26,
    SQLDBC_HOSTTYPE_UCS2_NATIVE_CLOB = SQLDBC_HOSTTYPE_UCS2_CLOB,
    SQLDBC_HOSTTYPE_STREAM = 27,
    SQLDBC_HOSTTYPE_RAWHEX = 28,
    SQLDBC_HOSTTYPE_DECIMAL = 29,
    SQLDBC_HOSTTYPE_OMS_PACKED_8_3 = 30,
    SQLDBC_HOSTTYPE_OMS_PACKED_15_3 = 31,
    SQLDBC_HOSTTYPE_OMS_TIMESTAMP = 32,
    SQLDBC_HOSTTYPE_OMS_ASCII = 33,
    SQLDBC_HOSTTYPE_DECFLOAT = 34,
    SQLDBC_HOSTTYPE_USERDEFINED = 100,
    SQLDBC_HOSTTYPE_MAX = SQLDBC_HOSTTYPE_USERDEFINED
  }

  Types of host (native) variables. More...
  

• enum SQLDBC_SQLWarningCode {
    SQLDBC_SQLWARNING_DATA_TRUNCATED = 1,
    SQLDBC_SQLWARNING_MAX
  }

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

• enum SQLDBC_DateTimeFormat_Format {
    SQLDBC_DateTimeFormat_Format_None_C = 0,
    SQLDBC_DateTimeFormat_Format_Normal_C = 1,
    SQLDBC_DateTimeFormat_Format_Iso_C = 2,
    SQLDBC_DateTimeFormat_Format_Usa_C = 3,
    SQLDBC_DateTimeFormat_Format_Eur_C = 4,
    SQLDBC_DateTimeFormat_Format_Jis_C = 5,
    SQLDBC_DateTimeFormat_Format_OracleDate_C = 6,
    SQLDBC_DateTimeFormat_Format_WasAnsiNowIsSameAsIso_C = 7,
    SQLDBC_DateTimeFormat_Format_TsEur_C = 8
  }

  The possible date/time formats. More...
  

• enum SQLDBC_SerialTag {
    SQLDBC_FIRST_INSERTED_SERIAL = 32768,
    SQLDBC_LAST_INSERTED_SERIAL = 32769
  }

  Possible values for getting the last inserted keys. More...
  

• enum SQLDBC_ProfileCountValues {
    SQLDBC_ALLOCATECOUNT = 0,
    SQLDBC_DEALLOCATECOUNT = 1,
    SQLDBC_CONNECTIONCOUNT = 2,
    SQLDBC_COMMITCOUNT = 3,
    SQLDBC_ROLLBACKCOUNT = 4,
    SQLDBC_SETISOLATIONCOUNT = 5,
    SQLDBC_SENDCOUNT = 6,
    SQLDBC_SENDSIZE = 7,
    SQLDBC_RECEIVESIZE = 8,
    SQLDBC_CANCELCOUNT = 9,
    SQLDBC_STATEMENTCOUNT = 10,
    SQLDBC_PREPAREDSTATEMENTCOUNT = 11,
    SQLDBC_NOTSELECTFETCHOPTIMIZED = 12,
    SQLDBC_DROPPARSEIDCOUNT = 13,
    SQLDBC_DROPCURSORCOUNT = 14,
    SQLDBC_DROPLONGDESCCOUNT = 15,
    SQLDBC_PREPARECOUNT = 16,
    SQLDBC_PARSEINFOHITCOUNT = 17,
    SQLDBC_PARSINFOMISSCOUNT = 18,
    SQLDBC_PARSEAGAINCOUNT = 19,
    SQLDBC_PARSEINFOSQUEEZECOUNT = 20,
    SQLDBC_EXECUTECOUNT = 21,
    SQLDBC_INSERTCOUNT = 22,
    SQLDBC_UPDATECOUNT = 23,
    SQLDBC_SELECTCOUNT = 24,
    SQLDBC_CALLDBPROCEDURECOUNT = 25,
    SQLDBC_DELETECOUNT = 26,
    SQLDBC_FETCHCOUNT = 27,
    SQLDBC_SQLERRORCOUNT = 28,
    SQLDBC_ROWNOTFOUNDCOUNT = 29,
    SQLDBC_FETCHROWCOUNT = 30,
    SQLDBC_DATAREADSIZE = 31,
    SQLDBC_DATAWRITESIZE = 32,
    SQLDBC_LONGDATAREADSIZE = 33,
    SQLDBC_LONGDATAWRITESIZE = 34,
    SQLDBC_PROFILE_MAX = 35
  }

  Possible profile counters. More...
  

---

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 112 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 288 of file SQLDBC_Types.h.

#define SQLDBC_DECIMAL_DIGITS (  indicator   )

Value: ( \ ((indicator) & 0xFFFF0000) == 0x40000000 \ ? ((indicator) & 0x0000FF00) >> 8 \ : (-1) \ ) Macro for extracting the number of digits of an indicator value. Parameters: indicator  The indicator value. The value is used twice in this macro. Returns: The number of digits, or -1 if the indicator value is invalid. Definition at line 359 of file SQLDBC_Types.h.

#define SQLDBC_DECIMAL_FRACTION (  indicator   )

Value: ( \ ((indicator) & 0xFFFF0000) == 0x40000000 \ ? ((indicator) & 0x000000FF) \ : (-1) \ ) Macro for extracting the number of digits of an indicator value. Parameters: indicator  The indicator value. The value is used twice in this macro. Returns: The number of digits, or -1 if the indicator value is invalid. Definition at line 371 of file SQLDBC_Types.h.

#define SQLDBC_DECIMAL_LENGTH (  digits, fraction   )     ((digits + 2) / 2)

Macro for length of decimal number. Parameters: digits  The number of decimal digits. fraction  The fraction. Returns: The length in bytes needed to store a BCD number with digits digits, having a fraction of fraction. Definition at line 350 of file SQLDBC_Types.h.

#define SQLDBC_DEFAULT_PARAM   (-5)

Flag indicating that the default parameter is to be used. Definition at line 303 of file SQLDBC_Types.h.

#define SQLDBC_FALSE   ((SQLDBC_Bool)0)

false value for the SQLDBC_Bool type. Definition at line 186 of file SQLDBC_Types.h.

#define SQLDBC_IGNORE   (-6)

Flag indicating that this parameter is to be ignored. Definition at line 308 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 329 of file SQLDBC_Types.h.

#define SQLDBC_LEN_DATA_AT_EXEC_OFFSET   (-100)

Offset for IFR_LEN_DATA_AT_EXEC. Definition at line 322 of file SQLDBC_Types.h.

#define SQLDBC_LEN_DECIMAL (  digits, fraction   )     (0x40000000 | ((digits & 0xFF) << 8) | (fraction & 0xFF))

Macro for decimal binding. Parameters: digits  The number of decimal digits. fraction  The fraction. Returns: A value that can be assigned to an indicator to describe the structure of a BCD value. Definition at line 340 of file SQLDBC_Types.h.

#define SQLDBC_LOB_KEEPALIVE   (-7)

Flag indicating that the LOB fetched using this as indicator value shall be kept until transaction end. Definition at line 315 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 298 of file SQLDBC_Types.h.

#define SQLDBC_NTS   (-3)

Indicator flag for the length of an zero-terminated string. Definition at line 293 of file SQLDBC_Types.h.

#define SQLDBC_NULL_DATA   (-1)

Indicator of NULL data in input/output. Definition at line 283 of file SQLDBC_Types.h.

#define SQLDBC_StringEncodingAscii   SQLDBC_StringEncodingType::Ascii

Plain 8-bit ASCII encoding (each byte stands for itself). Definition at line 481 of file SQLDBC_Types.h.

#define SQLDBC_StringEncodingUCS2   SQLDBC_StringEncodingType::UCS2

UCS2 big-endian encoding. Definition at line 487 of file SQLDBC_Types.h.

#define SQLDBC_StringEncodingUCS2Native   SQLDBC_StringEncodingType::UCS2

UCS2 little-endian encoding. Definition at line 502 of file SQLDBC_Types.h.

#define SQLDBC_StringEncodingUCS2Swapped   SQLDBC_StringEncodingType::UCS2Swapped

UCS2 little-endian encoding. Definition at line 493 of file SQLDBC_Types.h.

#define SQLDBC_StringEncodingUnknown   SQLDBC_StringEncodingType::Unknown

Unknown encoding (do not use). Definition at line 475 of file SQLDBC_Types.h.

#define SQLDBC_StringEncodingUTF8   SQLDBC_StringEncodingType::UTF8

UTF8 encoding. Definition at line 509 of file SQLDBC_Types.h.

#define SQLDBC_TRUE   ((SQLDBC_Bool)1)

true value for the SQLDBC_Bool type. Definition at line 183 of file SQLDBC_Types.h.

---

Typedef Documentation

typedef unsigned char SQLDBC_Byte

Type definition for an unsigned-byte. Definition at line 207 of file SQLDBC_Types.h.

typedef enum SQLDBC_DateTimeFormat_Format SQLDBC_DateTimeFormat_Format

The possible date/time formats.

typedef unsigned char SQLDBC_DecFloat

Type definition for a decfloat value. Definition at line 277 of file SQLDBC_Types.h.

typedef enum SQLDBC_HostType SQLDBC_HostType

Types of host (native) variables.

typedef signed int SQLDBC_Int

Standard signed-integer type of the platform. Definition at line 271 of file SQLDBC_Types.h.

typedef signed char SQLDBC_Int1

Signed 1-byte integer. Definition at line 224 of file SQLDBC_Types.h.

typedef signed short SQLDBC_Int2

Signed 2-byte integer. Definition at line 230 of file SQLDBC_Types.h.

typedef signed int SQLDBC_Int4

Signed 4-byte integer. Definition at line 236 of file SQLDBC_Types.h.

typedef long long SQLDBC_Int8

Signed 8-byte integer. Definition at line 251 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 262 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 201 of file SQLDBC_Types.h.

typedef enum SQLDBC_ProfileCountValues SQLDBC_ProfileCountValues

Possible profile counters.

typedef enum SQLDBC_Retcode SQLDBC_Retcode

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

typedef enum SQLDBC_Rowstatus 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.

typedef enum SQLDBC_SerialTag SQLDBC_SerialTag

Possible values for getting the last inserted keys.

typedef SQLDBC_ULong SQLDBC_size_t

Type definition for a memory size (size_t). Definition at line 212 of file SQLDBC_Types.h.

typedef enum SQLDBC_SQLMode SQLDBC_SQLMode

possible SQL modes.

typedef enum SQLDBC_SQLType 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.

typedef enum SQLDBC_SQLWarningCode SQLDBC_SQLWarningCode

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

typedef enum SQLDBC_StringEncodingType_Encoding SQLDBC_StringEncodingType_Encoding

typedef unsigned int SQLDBC_UInt

Standard unsigned-integer type of the platform. Definition at line 267 of file SQLDBC_Types.h.

typedef unsigned char SQLDBC_UInt1

Unsigned 1-byte integer. Definition at line 221 of file SQLDBC_Types.h.

typedef unsigned short SQLDBC_UInt2

Unsigned 2-byte integer. Definition at line 227 of file SQLDBC_Types.h.

typedef unsigned int SQLDBC_UInt4

Unsigned 4-byte integer. Definition at line 233 of file SQLDBC_Types.h.

typedef unsigned long long SQLDBC_UInt8

Unsigned 8-byte integer. Definition at line 248 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 196 of file SQLDBC_Types.h.

typedef SQLDBC_Byte SQLDBC_UTF8

Type definitions for an UTF8 character. Definition at line 217 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 694 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_DECIMAL  SQLDBC_HOSTTYPE_OMS_PACKED_8_3  SQLDBC_HOSTTYPE_OMS_PACKED_15_3  SQLDBC_HOSTTYPE_OMS_TIMESTAMP  SQLDBC_HOSTTYPE_OMS_ASCII  SQLDBC_HOSTTYPE_DECFLOAT  SQLDBC_HOSTTYPE_USERDEFINED  User-defined, must supply a parameter converter. SQLDBC_HOSTTYPE_MAX  Maximum value for checks. Definition at line 574 of file SQLDBC_Types.h.

enum SQLDBC_ProfileCountValues

Possible profile counters. Enumerator: SQLDBC_ALLOCATECOUNT  number of calling allocate SQLDBC_DEALLOCATECOUNT  number of calling deallocate SQLDBC_CONNECTIONCOUNT  number of objects of type SQLDBC_Connection SQLDBC_COMMITCOUNT  number of calling Commit SQLDBC_ROLLBACKCOUNT  number of calling Rollback SQLDBC_SETISOLATIONCOUNT  number of calling setIsolationLevel SQLDBC_SENDCOUNT  number of order packets send to the kernel SQLDBC_SENDSIZE  number of bytes send to the kernel SQLDBC_RECEIVESIZE  number of bytes received from the kernel SQLDBC_CANCELCOUNT  number of calling cancel SQLDBC_STATEMENTCOUNT  number of objects of type SQLDBC_Statement SQLDBC_PREPAREDSTATEMENTCOUNT  number of objects of type SQLDBC_PreparedStatement SQLDBC_NOTSELECTFETCHOPTIMIZED  number of SQL statements that wasn't Select/Fetch optimized SQLDBC_DROPPARSEIDCOUNT  number of parseids that were dropped SQLDBC_DROPCURSORCOUNT  number of cursor that were closed SQLDBC_DROPLONGDESCCOUNT  number of long descriptors that were closed SQLDBC_PREPARECOUNT  number of calling prepare SQLDBC_PARSEINFOHITCOUNT  hitcount of the parseinfo cache SQLDBC_PARSINFOMISSCOUNT  miscount of the parseinfo cache SQLDBC_PARSEAGAINCOUNT  number of internal ParseAgain loops SQLDBC_PARSEINFOSQUEEZECOUNT  squeeze count of the parseinfo cache SQLDBC_EXECUTECOUNT  number of calling Executes SQLDBC_INSERTCOUNT  number of INSERT statements SQLDBC_UPDATECOUNT  number of UPDATE statements SQLDBC_SELECTCOUNT  number of SELECT statements SQLDBC_CALLDBPROCEDURECOUNT  number of DBProcedure calls SQLDBC_DELETECOUNT  number of DELETE statements SQLDBC_FETCHCOUNT  number of FETCH statements send to the database kernel SQLDBC_SQLERRORCOUNT  number of SQL errors SQLDBC_ROWNOTFOUNDCOUNT  number of SELECT statements that return Row not found SQLDBC_FETCHROWCOUNT  number of all fetched rows SQLDBC_DATAREADSIZE  number of all databytes retrieved from the kernel SQLDBC_DATAWRITESIZE  number of all databytes send to the kernel SQLDBC_LONGDATAREADSIZE  number of bytes of all long data retrieved from the kernel SQLDBC_LONGDATAWRITESIZE  number of bytes of all long data send to the kernel SQLDBC_PROFILE_MAX  Maximum value for checks. Definition at line 729 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 385 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 SQLDBC_ROW_IGNORE  ignore this row in bulk operations Definition at line 410 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 713 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 434 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_VOID  Data type used for VOID types (? IS NULL etc.) 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 517 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 660 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 462 of file SQLDBC_Types.h.