The following sections present the EDS commands in alphabetic order. Each command reference includes the following information:
•Command name
•Purpose
•Conformance level
•Syntax
•Arguments
•Description of the command's functionality
•Return values
•References to related commands
Each description of an EDS command based on ODBC indicates whether that command is a Core, Level 1, or Level 2 function or subroutine. EDS High Level commands, which are based on commonly used combinations of Core commands, are designated as High Level functions or subroutines. Error handling is described in the EDSError command description. The text associated with SQLSTATE values is included to provide a description of the condition, but is not intended to prescribe specific text.
Arguments
Command arguments use a naming convention that consists of prefixes, tags, and suffixes.
Optional elements are enclosed in square brackets ([]). The following prefixes are used:
Prefix |
Description |
C |
Count of |
H |
Handle of |
I |
Index of |
The following tags are used:
Tag |
Description |
COL |
Column (of a result set) |
DBC |
Database connection |
ENV |
Environment |
ROW |
Row (of a result set) |
STMT |
Statement |
Prefixes and tags combine to form variable names. A representative sample is shown in the following table:
Combined |
Prefix |
Tag |
Description |
CROW |
C |
ROW |
Count of rows |
HDBC |
H |
DBC |
Connection handle |
HENV |
H |
ENV |
Environment handle |
HSTMT |
H |
STMT |
Statement handle |
HWND |
H |
WND |
Window handle |
ICOL |
I |
COL |
Column index |
IROW |
I |
ROW |
Row index |
In addition, the command arguments indicate the data type with the following suffixes:
Suffix |
Data Type |
_IV |
Integer |
_FV |
Float |
_STRUCT |
Structure |
_SV |
String |
For information about using pointers when calling ESL commands, refer to the Reference Guide for the ESL Language.
For definitions of the EDS structures, refer to the EDS.INC file installed with ESL.
Returns
Each EDS command returns a return code upon execution. The return code EDS_SUCCESS indicates that that command completed execution successfully. If the command returns EDS_ERROR or EDS_SUCCESS_WITH_INFO, you would typically call EDSError to get more information about the error. However, you can call EDSError after any EDS function call.
SQLSTATE Values
EDSError returns the SQLSTATE, which provides specific information about the error. Your application must handle the error situation.
The Returns provided with each command list the SQLSTATEs that may be returned for the command by the Driver Manager or a driver. Drivers can, however, return additional SQLSTATEs arising out of implementation-specific situations.
The character string value returned for a SQLSTATE consists of a two character class value followed by a three character subclass value. A class value of ‘01’ indicates a warning and is accompanied by a return code of EDS_SUCCESS_WITH_INFO. Class values other than ‘01’, except for the class ‘IM’, indicate an error and are accompanied by a return code of EDS_ERROR. The class ‘IM’ is specific to warnings and errors that derive from the implementation of ODBC itself. The subclass value ‘000’ in any class is for implementation-defined conditions within the given class. The assignment of class and subclass values is defined by ANSI SQL2.
Tables and Views
In EDS commands, tables and views are interchangeable. The term table is used for both tables and views, except where the term table or view is used explicitly.
