| |
rdoEnvironment
An rdoEnvironment object defines a logical set of connections and transaction scope for a particular username. It contains both open and allocated-but-umopened connections, provides mechanism for simultaneous transactions, and provides a security context for a data manipulation language (DML) operations on the database.
rdoEnvironment Object Properties
| Property |
Description |
| CursorDriver |
Returns or sets a value that specifies the type of cursor to create. If set to rdUseIfNeeded, the ODBC driver chooses the appropriate type of cursors. Server-side cursors are used if they are available. If set to rdUseODBC, RemoteData uses the ODBC cursor library. If set to rdUseServer, server-side cursors are used. If set to rdUseClientBatch, RDO uses the optimistic batch cursor library. |
| hEnv |
Returns a value corresponding to the ODBC environment handle. |
| LoginTimeout |
Returns or sets a value that specifies the number of seconds the ODBC driver waits before a timeout error occurs when a connection is opened. |
| Name |
Returns the name of a remote data object. |
| Password |
Represents the password used during creation of an rdoEnvironment object |
| Username |
Returns or sets a value that represents a user of an rdoEnvironment object. Use the UserName property with the Password property to connect to an ODBC data source. |
| Item |
Returns a specific member of an RDO collection object, either by position or by key. |
| rdoConnection |
Returns a specific member of an rdoConnections collection, either by position or by key. |
rdoEnvironment Object's Methods
| Methods |
Description |
| BeginTrans() |
Begins a new transaction |
| CommitTrans |
Ends the current transaction and saves the changes |
| RollbackTrans() |
Ends the current transaction and restores the databases in the rdoEnvironment object to the state they were in when the current transaction began |
| Close() |
Closes an open remote data object |
| OpenConnection() |
Opens a connection to an ODBC data source and returns a reference to the rdoConnection object that represents a specific database |
| Add() |
Adds a member to a collection object |
| Remove() |
Removes a member from a collection object |
rdoEnvironments
rdoEnvironment objects are created with the rdoCreateEnvironment() method of the rdoEngine object. Newly created rdoEnvironment objects are automatically appended to the rdoEnvironments collection, unless you either don't provide a name for the new object when using the rdoCreateEnvironment() method or simply declare a new rdoEnvironment object in code. The rdoEnvironments collection is automatically initialized with a default rdoEnvironment object, based on the default properties set in the rdoEngine object.
rdoEnvironments Object Properties
| Property |
Description |
| Item |
Returns a specific number of an RDO collection object, either by position or by key. |
| Count |
Returns the number of objects in a collection. |
rdoEnvironments Object Methods
| Method |
Description |
| Add() |
Adds a member to a Collection object. |
| Remove() |
Removes a member from a Collection object. |
rdoErrors
Any operation involving remote data objects can generate one or more errors. As each error occurs, one or more rdoError objects are placed in the rdoErrors collection of the rdoEngine object. When another RDO operation generates an error, the rdoErrors collection is cleared, and the new set of rdoError objects is placed in the rdoErrors collection. RDO operations that don't generate an error have no effect on the rdoErrors collection. The rdoErrors object supports just one method, Clear(), which clears all members from the rdoErrors collection. The Clear() method doesn't take any parameters.
rdoErrors Object Properties
| Property |
Description |
| Item |
Returns a specific member of an RDO collection object, either by position or by key. |
| Count |
Returns the number of objects in the rdoErrors collection. |
rdoError
Any operation involving remote data objects can potentially generate one or more ODBC errors or informational messages. As each error occurs, or as messages are generated, one or more rdoError objects are placed in the rdoErrors collection of the rdoEngine object. When a subsequent RDO operation generates an error, the rdoErrors collection is cleared, and the new set of rdoError objects is placed in the rdoErrors collection. RDO operations that don't generate an error have no effect on the rdoErrors collection. To make error handling easier, you can use the Clear() method to purge the rdoErrors collection between operations.
rdoErrors Object Properties
| Property |
Description |
| Description |
Returns a descriptive string associated with an error. |
| HelpContext |
Returns a context ID for a topic in a Microsoft Windows Help file. |
| HelpFile |
Returns as a variable a fully qualified path to the Help file. |
| Number |
Returns a numeric value specifying a native error. |
| Source |
Returns a value that indicates the source of a remote data access error. |
| SQLRetCode |
Returns the ODBC error return code from the most recent RDO operation. If set to rdSQLSuccess — the operation is successfull. If set to rdSQLSuccessWithInfo — the operation is seccessfull and additional operation is available. If set to rdSQLNoDataFound — no additional data is available. If set to rdSQLError — an error occurred performing the operation. If set to rdSQLInvalidHandle — the handle supplied is invalid. |
| SQLState |
Returns a value corresponding to the type of error, as defined by the X/Open and SQL standards. |
Copyright� 2000 by Noel
|