RWDBMsSqlLibSystemHandle Class Reference
[DB Access Module for Microsoft SQL Server]

Provides a mechanism for making direct calls to the Microsoft SQL Server API, and some methods for setting access module-specific properties. More...

#include <rw/db/msqsrc/msqsysh.h>

Inheritance diagram for RWDBMsSqlLibSystemHandle:

List of all members.

Public Member Functions
SQLHDBC	hdbc () const
SQLUINTEGER	cursorType () const
RWDBStatus	cursorType (SQLUINTEGER value)
bool	logTextUpdates () const
RWDBStatus	logTextUpdates (bool value)
SQLULEN	textSize () const
RWDBStatus	textSize (SQLULEN size)

---

Detailed Description

Class RWDBMsSqlLibSystemHandle provides methods for setting and retrieving options that affect performance. It also contains the SQLHDBC used by the RWDBConnection.

Note:

Use of this class reduces an application's portability.

Synopsis

 #include <rw/db/msqsrc/msqsysh.h>

 RWDBMsSqlLibSystemHandle* sys =
       (RWDBMsSqlLibSystemHandle*)myConnection.systemHandle();

Examples

If it is necessary for your application to make calls directly to the Microsoft SQL Server driver API, proceed as in the following example.

 #include <rw/db/msqsrc/msqsysh.h>

 RWDBConnection conn = myDbase.connection();
 RWDBMsSqlLibSystemHandle* handle =
                 (RWDBMsSqlLibSystemHandle*) conn.systemHandle();

 SQLHDBC sqlhdbc = handle->hdbc();
 // Use sqlhdbc for MS SQL Server ODBC API calls.

Note:

When using runtime loading of the DB Access Module for Microsoft SQL Server, the SQLHDBC is not available. For information, see the DB Access Module for Microsoft SQL Server User's Guide.

---

Member Function Documentation

RWDBStatus RWDBMsSqlLibSystemHandle::cursorType

(

SQLUINTEGER

value

)

[inline]

Sets the cursor type to value. The cursor types that can be set are SQL_CURSOR_KEYSET_DRIVEN, SQL_CURSOR_STATIC, SQL_CURSOR_FORWARD_ONLY, and SQL_CURSOR_DYNAMIC.

SQLUINTEGER RWDBMsSqlLibSystemHandle::cursorType

(

)

const [inline]

Returns the type of cursor in use. The default value is SQL_CURSOR_KEYSET_DRIVEN.

SQLHDBC RWDBMsSqlLibSystemHandle::hdbc

(

)

const

Returns the SQLHDBC encapsulated by the respective RWDBConnection.

RWDBStatus RWDBMsSqlLibSystemHandle::logTextUpdates

(

bool

value

)

[inline]

Changes the behavior for logging updates to text, ntext, and image columns. A value of false disables logging updates.

bool RWDBMsSqlLibSystemHandle::logTextUpdates

(

)

const [inline]

Returns true if the client library is to log updates to text, ntext, and image columns. This behavior is enabled by default.

RWDBStatus RWDBMsSqlLibSystemHandle::textSize

(

SQLULEN

size

)

[inline]

Sets the maximum length, in bytes, of text that a SELECT statement can return for text, ntext and image data, and returns an RWDBStatus indicating whether the operation succeeded.

SQLULEN RWDBMsSqlLibSystemHandle::textSize

(

)

const [inline]

Returns the maximum length, in bytes, of text that a SELECT statement can return for text, ntext, and image data. The default is 2,147,483,647 for the Microsoft SQL Server ODBC driver, but may vary for other drivers.