SQLConnection Class (Typed) |  |
Manage an SQL connection to an ODBC data source. A SQLConnection object is needed before any database operations can be performed.
Inheritance HierarchyNamespace: XSharp.VO.SDK
Assembly: XSharp.VOSQLClasses (in XSharp.VOSQLClasses.dll) Version: 2.19
SyntaxThe SQLConnection type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SQLConnection |
Construct an SQL connection.
|
Properties| Name | Description | |
|---|---|---|
 | AccessMode |
A constant representing the SQL connection's access mode.
|
| Connected |
A logical value representing whether the SQL connection object is connected.
|
| ConnectionHandle | |
| ConnectString |
A string representing the connection parameters (for example, "DSN=<Source>;UID=<UserID>;PWD=<Authorization>"). This string is initialized during the SQLConnection:Connect() or SQLConnection:DriverConnect() methods.
|
| ConnHandle | Obsolete.
A long integer representing the connection handle.
|
| DataSource |
A string representing the ODBC data source name.
|
| DataSourceName | |
| DataSourceVersion | |
| ErrInfo | SqlErrorInfo object for the last error occured for the connection or NIL. |
| Factory | |
| GroupByBehavior | |
| HyperLabel |
The hyperlabel of the connection containing the name of the data source, or NIL, if there is no data source name.
|
| IdentifierCase | |
| IdentifierQuoteChar |
A string used to surround a delimited identifier for this connection.
|
| IsolationOption | Obsolete.
A constant representing the isolation level of the SQL connection.
|
| NetConn | |
| ODBCCursors | Obsolete.
A constant representing the cursor type for the SQL connection.
|
| OrderByColumnsInSelect | |
| Password |
A string containing the ODBC password (authorization string).
|
| PositionOps | Obsolete.
A logical value representing whether the driver supports positioned operations
|
| QuotedIdentifierCase | |
| ScrollConcurrency | Obsolete.
A constant representing the concurrency level of the SQL connection.
|
| ScrollCsr | Obsolete.
A logical value representing whether the driver supports scrollable cursors.
|
| Server | |
| Status |
A hyperlabel of the SQLConnection object containing the error message, or NULL_OBJECT, if no error has occurred.
|
| SupportedJoinOperators | |
| UserID |
A string representing the ODBC user ID.
|
Functions| Name | Description | |
|---|---|---|
| _CreateCommand | |
| _CreateConnection | |
| _CreateDataAdapter | |
| _CreateParameter | |
| _ParseConnectionString | |
| _ReadProperties | |
| BeginTransaction | |
| Commit | |
| Connect |
Connect a user to an ODBC data source.
|
| Disconnect |
Disconnect the current user from an ODBC data source.
|
| DoSimpleSelect | |
| DriverConnect |
Display a dialog box prompting for a source; after a source is selected, displays the driver's connection dialog box; then connects to the selected data source.
|
| EndTransaction | |
| GetConnectOption | Obsolete.
Return current setting for a connection option.
|
 | GetODBCDataSources | |
| GetSchema | |
| GetSchemaTable | |
| Info |
Return current setting for connection information.
|
| isFunction | Obsolete.
Determine whether an ODBC function is supported by the driver.
|
| NetConnect | |
| Reconnect |
Disconnect the current user from a data source; if connected; then, connect.
|
| Rollback | |
| SetConnectOption | Obsolete.
Set the value of a connection option.
|
Remarks
An SQLConnection object represents the connection to an ODBC data source. The data source (associated with a particular database) is set-up using the Microsoft ODBC administrator.
Examples
The following example demonstrates how to establish a connection to a source named SAMPLE:
X#
1FUNCTION Start() 2LOCAL oConn AS SQLConnection 3oConn := SQLConnection{} 4// SAMPLE source has been set up to connect to // WATCOM 5oConn:Connect("sample","dba","sql") 6// Check for errors 7IF IsNil(oConn:ErrInfo) 8oConn:Disconnect() 9ELSE 10oConn:ErrInfo:ShowErrorMsg() 11ENDIF
See Also