Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

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.

Compounds

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 44 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 165 of file SQLDBC_Types.h.

#define SQLDBC_DEFAULT_PARAM   (-5)
 

Flag indicating that the default parameter is to be used.

Definition at line 180 of file SQLDBC_Types.h.

#define SQLDBC_FALSE   ((SQLDBC_Bool)0)
 

false value for the SQLDBC_Bool type.

Definition at line 70 of file SQLDBC_Types.h.

#define SQLDBC_IGNORE   (-6)
 

Flag indicating that this parameter is to be ignored.

Definition at line 185 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 198 of file SQLDBC_Types.h.

#define SQLDBC_LEN_DATA_AT_EXEC_OFFSET   (-100)
 

Offset for IFR_LEN_DATA_AT_EXEC.

Definition at line 191 of file SQLDBC_Types.h.

#define SQLDBC_NO_TOTAL   (-4)
 

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

Definition at line 175 of file SQLDBC_Types.h.

#define SQLDBC_NTS   (-3)
 

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

Definition at line 170 of file SQLDBC_Types.h.

#define SQLDBC_NULL_DATA   (-1)
 

Indicator of NULL data in input/output.

Definition at line 160 of file SQLDBC_Types.h.

#define SQLDBC_StringEncodingAscii   SQLDBC_StringEncodingType::Ascii
 

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

Definition at line 266 of file SQLDBC_Types.h.

#define SQLDBC_StringEncodingUCS2   SQLDBC_StringEncodingType::UCS2
 

UCS2 big-endian encoding.

Definition at line 272 of file SQLDBC_Types.h.

#define SQLDBC_StringEncodingUCS2Native   SQLDBC_StringEncodingType::UCS2Native
 

UCS2 little-endian encoding.

Definition at line 284 of file SQLDBC_Types.h.

#define SQLDBC_StringEncodingUCS2Swapped   SQLDBC_StringEncodingType::UCS2Swapped
 

UCS2 little-endian encoding.

Definition at line 278 of file SQLDBC_Types.h.

#define SQLDBC_StringEncodingUnknown   SQLDBC_StringEncodingType::Unknown
 

Unknown encoding (do not use).

Definition at line 260 of file SQLDBC_Types.h.

#define SQLDBC_StringEncodingUTF8   SQLDBC_StringEncodingType::UTF8
 

UTF8 encoding.

Definition at line 290 of file SQLDBC_Types.h.

#define SQLDBC_TRUE   ((SQLDBC_Bool)1)
 

true value for the SQLDBC_Bool type.

Definition at line 67 of file SQLDBC_Types.h.


Typedef Documentation

typedef unsigned char SQLDBC_Byte
 

Type definition for an unsigned-byte.

Definition at line 91 of file SQLDBC_Types.h.

typedef signed int SQLDBC_Int
 

Standard signed-integer type of the platform.

Definition at line 155 of file SQLDBC_Types.h.

typedef signed char SQLDBC_Int1
 

Signed 1-byte integer.

Definition at line 108 of file SQLDBC_Types.h.

typedef signed short SQLDBC_Int2
 

Signed 2-byte integer.

Definition at line 114 of file SQLDBC_Types.h.

typedef signed int SQLDBC_Int4
 

Signed 4-byte integer.

Definition at line 120 of file SQLDBC_Types.h.

typedef long long SQLDBC_Int8
 

Signed 8-byte integer.

Definition at line 135 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 146 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 85 of file SQLDBC_Types.h.

typedef SQLDBC_ULong SQLDBC_size_t
 

Type definition for a memory size (size_t).

Definition at line 96 of file SQLDBC_Types.h.

typedef SQLDBC_StringEncodingType::Encoding SQLDBC_StringEncoding
 

Definition at line 254 of file SQLDBC_Types.h.

typedef unsigned int SQLDBC_UInt
 

Standard unsigned-integer type of the platform.

Definition at line 151 of file SQLDBC_Types.h.

typedef unsigned char SQLDBC_UInt1
 

Unsigned 1-byte integer.

Definition at line 105 of file SQLDBC_Types.h.

typedef unsigned short SQLDBC_UInt2
 

Unsigned 2-byte integer.

Definition at line 111 of file SQLDBC_Types.h.

typedef unsigned int SQLDBC_UInt4
 

Unsigned 4-byte integer.

Definition at line 117 of file SQLDBC_Types.h.

typedef unsigned long long SQLDBC_UInt8
 

Unsigned 8-byte integer.

Definition at line 132 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 80 of file SQLDBC_Types.h.

typedef SQLDBC_Byte SQLDBC_UTF8
 

Type definitions for an UTF8 character.

Definition at line 101 of file SQLDBC_Types.h.


Enumeration Type Documentation

enum SQLDBC_HostType
 

Types of host (native) variables.

Enumeration values:
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_USERDEFINED  User-defined, must supply a parameter converter.
SQLDBC_HOSTTYPE_MAX  Maximum value for checks.

Definition at line 346 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.

Enumeration values:
SQLDBC_INVALID_OBJECT  Application tries to use an invalid object reference.
SQLDBC_OK  Function call successfull.
SQLDBC_NOT_OK  Function call not successfull.

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

enum SQLDBC_Rowstatus
 

Row status for mass operations. The status for an inserted row is either one of these constants, or the row count of the individual column.

Enumeration values:
SQLDBC_EXECUTE_FAILED  Execute of this row failed.
SQLDBC_SUCCESS_NO_INFO  Execute succeeded, no information about affected rows available.

Definition at line 222 of file SQLDBC_Types.h.

enum SQLDBC_SQLMode
 

possible SQL modes.

Enumeration values:
SQLDBC_INTERNAL  SQL mode INTERNAL.
SQLDBC_ANSI 
Deprecated:
SQL mode ANSI.
SQLDBC_DB2 
Deprecated:
SQL mode DB2.
SQLDBC_ORACLE  SQL mode ORACLE.

Definition at line 234 of file SQLDBC_Types.h.

enum SQLDBC_SQLType
 

Constants used for SQL datatypes.

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

Enumeration values:
SQLDBC_SQLTYPE_MIN  Minimum value internally used for checks.
SQLDBC_SQLTYPE_FIXED 
SQLDBC_SQLTYPE_FLOAT 
SQLDBC_SQLTYPE_CHA  Data type CHAR ASCII.
SQLDBC_SQLTYPE_CHE 
SQLDBC_SQLTYPE_CHB 
SQLDBC_SQLTYPE_ROWID 
SQLDBC_SQLTYPE_STRA 
SQLDBC_SQLTYPE_STRE 
SQLDBC_SQLTYPE_STRB 
SQLDBC_SQLTYPE_STRDB 
SQLDBC_SQLTYPE_DATE 
SQLDBC_SQLTYPE_TIME 
SQLDBC_SQLTYPE_VFLOAT 
SQLDBC_SQLTYPE_TIMESTAMP 
SQLDBC_SQLTYPE_UNKNOWN 
SQLDBC_SQLTYPE_NUMBER 
SQLDBC_SQLTYPE_NONUMBER 
SQLDBC_SQLTYPE_DURATION 
SQLDBC_SQLTYPE_DBYTEEBCDIC 
SQLDBC_SQLTYPE_LONGA 
SQLDBC_SQLTYPE_LONGE 
SQLDBC_SQLTYPE_LONGB 
SQLDBC_SQLTYPE_LONGDB 
SQLDBC_SQLTYPE_BOOLEAN 
SQLDBC_SQLTYPE_UNICODE 
SQLDBC_SQLTYPE_DTFILLER1 
SQLDBC_SQLTYPE_DTFILLER2 
SQLDBC_SQLTYPE_DTFILLER3 
SQLDBC_SQLTYPE_DTFILLER4 
SQLDBC_SQLTYPE_SMALLINT 
SQLDBC_SQLTYPE_INTEGER 
SQLDBC_SQLTYPE_VARCHARA 
SQLDBC_SQLTYPE_VARCHARE 
SQLDBC_SQLTYPE_VARCHARB 
SQLDBC_SQLTYPE_STRUNI 
SQLDBC_SQLTYPE_LONGUNI 
SQLDBC_SQLTYPE_VARCHARUNI 
SQLDBC_SQLTYPE_UDT 
SQLDBC_SQLTYPE_ABAPTABHANDLE 
SQLDBC_SQLTYPE_DWYDE 
SQLDBC_SQLTYPE_MAX  Maximum value for checks.

Definition at line 298 of file SQLDBC_Types.h.

enum SQLDBC_SQLWarningCode
 

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

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

Definition at line 398 of file SQLDBC_Types.h.