Microsoft Access 97 comes with a utility known as the Object Browser , which can be used to explore the DAO object hierarchy. Figure A-1 shows the Object Browser, which can be invoked from an Access code module by striking the F2 function key (or from the View menu).
The Object Browser can be a very useful tool, but there are times when a hardcopy reference is also useful. Accordingly, this appendix contains information on the collections, properties, and methods of each of the objects in the DAO 3.0 object hierarchy (which underlies Access 95) and the DAO 3.5 (which underlies Access 97). If nothing else, this information should help point you to the right spot in the Access Online Help System.
In this DAO reference, a table listing the classes and collections available in DAO is followed by tables listing the properties and methods exposed by each class, as well as the collections that are accessible from each object. The tables also indicate whether each item applies to DAO 3.0, DAO 3.5, or both. Finally, there is a summary description of each item.
Class name | Version | Description |
3.5 | An open ODBCDirect connection | |
3.5 | A collection of Connection objects | |
3.0/3.5 | Storage for information about a predefined object type | |
3.0/3.5 | A collection of Container objects | |
Database | 3.0/3.5 | An open database |
Databases | 3.0/3.5 | A collection of Database objects |
DBEngine | 3.0/3.5 | The Jet database engine |
Document | 3.0/3.5 | Information about a saved, predefined object |
Documents | 3.0/3.5 | A collection of Document objects |
Error | 3.0/3.5 | Information about any error that occurred with a DAO object |
Errors | 3.0/3.5 | A collection of Error objects |
Field | 3.0/3.5 | A column that is part of a table, query, index, relation, or recordset |
Fields | 3.0/3.5 | A collection of Field objects |
Group | 3.0/3.5 | A group of user accounts |
Groups | 3.0/3.5 | A collection of Group objects |
Index | 3.0/3.5 | Object used to order values and provide efficient access to a recordset |
Indexes | 3.0/3.5 | A collection of Index objects |
Parameter | 3.0/3.5 | Parameter for a parameter query |
Parameters | 3.0/3.5 | A collection of Parameter objects |
Properties | 3.0/3.5 | A collection of Property objects |
Property | 3.0/3.5 | A built-in or user-defined property |
QueryDef | 3.0/3.5 | A saved query definition |
QueryDefs | 3.0/3.5 | A collection of Querydef objects |
Recordset | 3.0/3.5 | The representation of the records in a table or that result from a query |
Recordsets | 3.0/3.5 | A collection of Recordset objects |
Relation | 3.0/3.5 | A relationship between fields in tables and queries |
Relations | 3.0/3.5 | A collection of Relation objects |
TableDef | 3.0/3.5 | A saved table definition |
TableDefs | 3.0/3.5 | A collection of Tabledef objects |
User | 3.0/3.5 | A user account |
Users | 3.0/3.5 | A collection of User objects |
Workspace | 3.0/3.5 | A session of the Jet database engine |
Workspaces | 3.0/3.5 | A collection of Workspace objects |
Each of the Collection objects listed earlier in Section A.1 supports a single method and a single property.
In addition, DynaCollection objects—that is, Collection objects whose members can be dynamically added and removed—have the two additional methods.
Method | Parameters | Returns | Version | Description |
Cancel | Sub | 3.5 | Cancels execution of an asynchronous Execute or OpenRecordset method | |
Close | Sub | 3.5 | Closes the Connection object and everything it contains | |
CreateQueryDef | [Name], [SQLText] | QueryDef | 3.5 | Creates a new QueryDef object |
Execute | Query As String, [Options] | Sub | 3.5 | Executes an SQL statement |
OpenRecordSet | Name As String, [Type], [Options], [LockEdit] | Recordset | 3.5 | Creates a new Recordset object |
Property | Type | Version | Description |
Connect | String | 3.5 | Information saved from the Connect argument of the OpenDatabase method |
Name | String | 3.5 | Name of the Connection object |
QueryTimeout | Integer | 3.5 | Number of seconds before timeout occurs when executing an ODBC query |
RecordsAffected | Long | 3.5 | Number of records affected by the last Execute method |
StillExecuting | Boolean | 3.5 | Indicates whether an asynchronous method call is still executing |
Transactions | Boolean | 3.5 | Indicates whether the DAO object supports transactions |
Updatable | Boolean | 3.5 | Indicates whether the connection allows data to be updated |
Property | Type | Version | Description |
AllPermissions | Long | 3.0/3.5 | All permissions that apply to the current username |
Inherit | Boolean | 3.0/3.5 | Indicates whether new Document objects inherit default permissions properties |
Name | String | 3.0/3.5 | The name of this object |
Owner | String | 3.0/3.5 | Sets or returns the owner of the object |
Permissions | Long | 3.0/3.5 | Sets or returns permissions for the user or group indicated by the UserName property when accessing the object |
UserName | String | 3.0/3.5 | User or group to which the Permissions property applies |
Property | Type | Version | Description |
Connection | 3.5 | An open ODBCDirect connection | |
Containers | Containers | 3.0/3.5 | Collection of Container objects in the Database object |
QueryDefs | QueryDefs | 3.0/3.5 | Collection of QueryDef objects in the Database object |
Recordsets | Recordsets | 3.0/3.5 | Collection of Recordset objects open in Database object |
Relations | Relations | 3.0/3.5 | Collection of Relation objects in the Database object |
TableDefs | TableDefs | 3.0/3.5 | Collection of TableDef objects in the Database object |
Method | Parameters | Returns | Version | Description |
Close | Sub | 3.0/3.5 | Closes the Database object and everything it contains | |
CreateProperty | [Name], [Type], [Value], [DDL] | Property | 3.0/3.5 | Creates a new user-defined Property object |
CreateQueryDef | [Name], [SQLText] | QueryDef | 3.0/3.5 | Creates a new QueryDef object |
CreateRelation | [Name], [Table], [ForeignTable], [Attributes] | Relation | 3.0/3.5 | Creates a new Relation object |
CreateTableDef | [Name], [Attributes], [SourceTableName], [Connect] | TableDef | 3.0/3.5 | Creates a new TableDef object |
Execute | Query As String, [Options] | Sub | 3.0/3.5 | Executes a query |
MakeReplica | PathName As String, Description As String, [Options] | Sub | 3.0/3.5 | Makes a new replica based on the current replicable database |
NewPassword | bstrOld As String, bstrNew As String | Sub | 3.0/3.5 | Changes the password of an existing database |
OpenRecordset | Name As String, [Type], [Options] | Recordset | 3.0/3.5 | Creates a new Recordset object |
PopulatePartial | DbPathName As String | Sub | 3.5 | Synchronizes a partial replica |
Synchronize | DbPathName As String, [ExchangeType] | Sub | 3.0/3.5 | Synchronizes the database object |
Property | Type | Version | Description |
CollatingOrder | Long | 3.0/3.5 | Defines the order used for sorting and comparisons |
Connect | String | Information saved from the Connect argument of the OpenDatabase method | |
DesignMasterID | String | 3.0/3.5 | Unique identifier for a replica design master |
Name | String | 3.0/3.5 | The name of this Database object |
QueryTimeout | Integer | 3.0/3.5 | Number of seconds before timeout occurs when executing an ODBC query |
RecordsAffected | Long | 3.0/3.5 | Number of records affected by the last Execute method |
ReplicaID | String | 3.0/3.5 | Unique identifier for a replica |
Transactions | Boolean | 3.0/3.5 | Indicates whether the Database object supports transactions |
Updatable | Boolean | 3.0/3.5 | Indicates whether the Database object can be modified |
Version | String | 3.0/3.5 | Version number of the Database object format |
Method | Parameters | Returns | Version | Description |
BeginTrans | Sub | 3.0/3.5 | Begins a new transaction | |
CommitTrans | Sub | 3.0 | Ends the transaction and saves any changes | |
CommitTrans | [Option as Long] | Sub | 3.5 | Ends the transaction and saves any changes |
CompactDatabase | SrcName As String, DstName As String, [DstConnect], [Options], [SrcConnect] | Sub | 3.0 | Compacts a closed database |
CompactDatabase | SrcName As String, DstName As String, [DstLocale], [Options], [SrcLocale] | Sub | 3.5 | Compacts a closed database |
CreateDatabase | Name As String, Connect As String, [Option] | Database | 3.0 | Creates a new database |
CreateDatabase | Name As String, Locale As String, [Option] | Database | 3.5 | Creates a new .mdb database |
CreateWorkspace | Name As String, UserName As String, Password As String | Workspace | 3.0 | Creates a new Workspace object |
CreateWorkspace | Name As String, UserName As String, Password As String, [UseType] | Workspace | 3.5 | Creates a new Workspace object |
Idle | [Action] | Sub | 3.0/3.5 | Completes pending engine tasks such as lock removal |
OpenConnection | Name As String, [Options], [ReadOnly], [Connect] | Connection | 3.5 | Opens a connection to a database |
OpenDatabase | Name As String, [Exclusive], [ReadOnly], [Connect] | Database | 3.0 | Opens a specified database |
OpenDatabase | Name As String, [Options], [ReadOnly], [Connect] | Database | 3.5 | Opens a specified database |
RegisterDatabase | Dsn As String, Driver As String, Silent As Boolean, Attributes As String | Sub | 3.0/3.5 | Enters connection information for an ODBC data source |
RepairDatabase | Name As String | Sub | 3.0/3.5 | Repairs a corrupted database |
Rollback | Sub | 3.0/3.5 | Rolls back any changes since the last BeginTrans | |
SetOption | Option As Long, Value | Sub | 3.5 | Overrides Jet registry settings |
Property | Type | Version | Description |
DefaultPassword | String | 3.0/3.5 | Password if a Workspace object is created without a password |
DefaultType | Long | 3.5 | Sets the default Workspace type |
DefaultUser | String | 3.0/3.5 | Username if a Workspace object is created without a username |
IniPath | String | 3.0/3.5 | Path and filename of the initialization file (in Jet 3.0) or the complete Registry path (Jet 3.5) containing Jet engine settings |
LoginTimeout | Integer | 3.0/3.5 | Number of seconds allowed for logging in to an ODBC database |
SystemDB | String | 3.0/3.5 | Path to the system database |
Version | String | 3.0/3.5 | Version number of the Jet database engine |
Property | Type | Version | Description |
AllPermissions | Long | 3.0/3.5 | All permissions that apply to the current username |
Container | String | 3.0/3.5 | Name of the Container object to which this Document object belongs |
DateCreated | Variant | 3.0/3.5 | Date and time the Document object was created |
LastUpdated | Variant | 3.0/3.5 | Date and time of the most recent change to the Document object |
Name | String | 3.0/3.5 | Name of this Document object |
Owner | String | 3.0/3.5 | The owner of the object |
Permissions | Long | 3.0/3.5 | Permissions for user or group accessing the Document object |
UserName | String | 3.0/3.5 | User or group for which the Permissions property applies |
Property | Type | Version | Description |
String | 3.0/3.5 | Description of the error | |
HelpContext | Long | 3.0/3.5 | Help context ID for a topic describing the error |
HelpFile | String | 3.0/3.5 | Path to Help file describing the error |
Number | Long | 3.0/3.5 | Error code of the most recent error |
Source | String | 3.0/3.5 | Name of the object class that generated the error |
Method | Parameters | Returns | Version | Description |
AppendChunk | Val | Sub | 3.0/3.5 | Writes long binary data to a field |
CreateProperty | [Name], [Type], [Value], [DDL] | Property | 3.0/3.5 | Creates a new user-defined Property object |
FieldSize | Long | 3.0 | Returns the FieldSize field | |
GetChunk | Offset As Long, Bytes As Long | Byte | 3.0/3.5 | Reads binary data from a field |
Property | Type | Version | Description |
AllowZeroLength | Boolean | 3.0/3.5 | Indicates whether a zero-length string is valid for this field |
Attributes | Long | 3.0/3.5 | Value indicating characteristics of this Field object |
CollatingOrder | Long | 3.0/3.5 | Language used for sorting and comparisons |
DataUpdatable | Boolean | 3.0/3.5 | Indicates whether the data in the field are updatable |
DefaultValue | String | 3.0/3.5 | Default value of the field for a new record |
FieldSize | Long | 3.5 | The size of a memo field or a long binary field |
ForeignName | String | 3.0/3.5 | The name of the foreign field |
Name | String | 3.0/3.5 | The name of this Field object |
OrdinalPosition | Integer | 3.0/3.5 | The relative position of this field object |
OriginalValue | Variant | 3.5 | Value stored in the database server at the start of a batch update |
Required | Boolean | 3.0/3.5 | Indicates whether the Field requires a non-Null value |
Size | Long | 3.0/3.5 | Maximum size of the field |
SourceField | String | 3.0/3.5 | Name of the original source of data for a Field object |
SourceTable | String | 3.0/3.5 | Name of the original source table |
Type | Integer | 3.0/3.5 | Data type of the field |
ValidateOnSet | Boolean | 3.0/3.5 | Determines whether validation occurs immediately (a True value) or is delayed until an update (a False value) |
ValidationRule | String | 3.0/3.5 | Expression that must evaluate to True for a successful update |
ValidationText | String | 3.0/3.5 | Message to display if validation with ValidationRule fails |
Value | Variant | 3.0/3.5 | The Field object’s data |
VisibleValue | Variant | 3.5 | Data currently stored in the database server |
Property | Type | Version | Description |
Clustered | Boolean | 3.0/3.5 | Indicates whether the index is clustered |
DistinctCount | Long | 3.0/3.5 | Number of unique values in this Index object |
Foreign | Boolean | 3.0/3.5 | Indicates whether an Index object represents a foreign key |
IgnoreNulls | Boolean | 3.0/3.5 | Indicates whether Null values are stored in the index |
Name | String | 3.0/3.5 | Name of this Index object |
Primary | Boolean | 3.0/3.5 | Indicates whether this is a primary index |
Required | Boolean | 3.0/3.5 | Indicates whether the index requires a non-Null value |
Unique | Boolean | 3.0/3.5 | Indicates whether this is a unique index for a table |
Method | Parameters | Returns | Version | Description |
Cancel | Sub | 3.5 | Cancels execution of an asynchronous OpenRecordset method | |
Close | Sub | 3.0/3.5 | Closes the open QueryDef object | |
CreateProperty | [Name], [Type], [Value], [DDL] | Property | 3.0/3.5 | Creates a new user-defined Property object |
Execute | [Options] | Sub | 3.0/3.5 | Execute the Querydef |
OpenRecordset | [Type], [Options] | Recordset | 3.0 | Creates a new Recordset object |
OpenRecordset | [Type], [Options], [LockEdit] | Recordset | 3.5 | Creates a new Recordset object |
Property | Type | Version | Description |
CacheSize | Long | 3.5 | Number of records to be locally cached from an ODBC data source |
Connect | String | 3.0/3.5 | Value providing information about a data source for a QueryDef |
DateCreated | Variant | 3.0/3.5 | Date and time the QueryDef was created |
LastUpdated | Variant | 3.0/3.5 | Date and time of the most recent change to the QueryDef |
MaxRecords | Long | 3.5 | Maximum number of records to return from the query |
Name | String | 3.0/3.5 | Name of this QueryDef object |
ODBCTimeout | Integer | 3.0/3.5 | Number of seconds to wait before a timeout occurs when querying an ODBC database |
Prepare | Variant | 3.5 | Indicates whether to prepare a temporary stored procedure from the query |
RecordsAffected | Long | 3.0/3.5 | Number of records affected by the last Execute method |
ReturnsRecords | Boolean | 3.0/3.5 | Indicates whether an SQL pass-through query returns records |
SQL | String | 3.0/3.5 | SQL statement that defines the query |
StillExecuting | Boolean | 3.5 | Indicates whether an asynchronous method call is still executing |
Type | Integer | 3.0/3.5 | The data type of the object |
Updatable | Boolean | 3.0/3.5 | Indicates whether the query definition can be changed |
Method | Parameters | Returns | Version | Description |
AddNew | Sub | 3.0/3.5 | Adds a new record to the Recordset | |
Cancel | Sub | 3.5 | Cancels execution of an asynchronous Execute, OpenRecordset, or OpenConnection method | |
CancelUpdate | Sub | 3.0/3.5 | Cancels any pending AddNew or Update statements | |
Clone | Recordset | 3.0/3.5 | Creates a duplicate Recordset | |
Close | Sub | 3.0/3.5 | Closes an open Recordset object | |
CopyQueryDef | QueryDef | 3.0/3.5 | Returns a copy of the QueryDef that created the Recordset | |
Delete | Sub | 3.0/3.5 | Deletes a record from the Recordset | |
Edit | Sub | 3.0/3.5 | Prepares a row of the Recordset for editing | |
FillCache | [Rows], [StartBookmark] | Sub | 3.0/3.5 | Fills the cache for an ODBC-derived Recordset |
FindFirst | Criteria As String | Sub | 3.0/3.5 | Locates the first record that satisfies the criteria |
FindLast | Criteria As String | Sub | 3.0/3.5 | Locates the last record that satisfies the criteria |
FindNext | Criteria As String | Sub | 3.0/3.5 | Locates the next record that satisfies the criteria |
FindPrevious | Criteria As String | Sub | 3.0/3.5 | Locates the previous record that satisfies the criteria |
GetRows | [cRows] | Variant | 3.0/3.5 | Writes multiple records into an array |
Move | Rows As Long, [StartBookmark] | Sub | 3.0/3.5 | Repositions the record pointer relative to the current position or to a bookmark |
MoveFirst | Sub | 3.0/3.5 | Moves to the first record in the Recordset | |
MoveLast | Sub | 3.0 | Moves to the last record in the Recordset | |
MoveLast | [Options As Long] | Sub | 3.5 | Moves to the last record in the Recordset |
MoveNext | Sub | 3.0/3.5 | Moves to the next record in the Recordset | |
MovePrevious | Sub | 3.0/3.5 | Moves to the previous record in the Recordset | |
NextRecordset | Boolean | 3.5 | Retrieves the next recordset in a multiquery Recordset | |
OpenRecordset | [Type], [Options] | Recordset | 3.0/3.5 | Creates a new Recordset object |
Requery | [NewQueryDef] | Sub | 3.0/3.5 | Re-executes the query on which the Recordset is based |
Seek | Comparison As String, Key1... | Sub | 3.0/3.5 | Locates a record in a table-type Recordset |
Update | Sub | 3.0/3.5 | Saves changes initiated by the Edit or AddNew methods |
Property | Type | Version | Description |
AbsolutePosition | Long | 3.0/3.5 | Returns or sets the relative record number of the current record |
BatchCollisionCount | Long | 3.5 | Indicates the number of rows having collisions in the last batch update |
BatchCollisions | Variant | 3.5 | Indicates which rows had collisions in the last batch update |
BatchSize | Long | 3.5 | Determines how many updates to include in a batch |
BOF | Boolean | 3.0/3.5 | Indicates whether the current record position is before the first record |
Bookmark As | Byte | 3.0/3.5 | Uniquely identifies a particular record in a Recordset |
Bookmarkable | Boolean | 3.0/3.5 | Indicates whether a Recordset supports bookmarks |
CacheSize | Long | 3.0/3.5 | Indicates the number of records from an ODBC data source to be cached locally |
CacheStart As | Byte | 3.0/3.5 | Bookmarks the first record to be cached from an ODBC data source |
DateCreated | Variant | 3.0/3.5 | Indicates the date and time when the underlying base table was created |
EditMode | Integer | 3.0/3.5 | Indicates the state of editing for the current record |
EOF | Boolean | 3.0/3.5 | Indicates whether the current record position is after the last record |
Filter | String | 3.0/3.5 | Defines a filter to apply to a Recordset |
Index | String | 3.0/3.5 | Indicates the name of the current Index object (table-type Recordset only) |
LastModified As | Byte | 3.0/3.5 | Bookmarks indicating the most recently added or changed record |
LastUpdated | Variant | 3.0/3.5 | Indicates the date and time of the most recent change to the underlying base table |
LockEdits | Boolean | 3.0/3.5 | Indicates the type of locking (optimistic or pessimistic) in effect during editing |
Name | String | 3.0/3.5 | Indicates the name of the Recordset object |
NoMatch | Boolean | 3.0/3.5 | Indicates whether the Seek or Find methods succeeded in finding a record |
PercentPosition | Single | 3.0/3.5 | Indicates or changes the approximate location of the current record |
RecordCount | Long | 3.0/3.5 | Indicates the number of records in the Recordset object |
RecordStatus | Integer | 3.5 | Indicates the batch-update status of the current record |
Restartable | Boolean | 3.0/3.5 | Indicates whether the Recordset supports the Requery method |
Sort | String | 3.0/3.5 | Defines the sort order for records in a Recordset |
StillExecuting | Boolean | 3.5 | Indicates whether an asynchronous method call is still executing |
Transactions | Boolean | 3.0/3.5 | Indicates whether the Recordset supports transactions |
Type | Integer | 3.0/3.5 | Indicates the object’s data type |
Updatable | Boolean | 3.0/3.5 | Indicates whether records in the Recordset can be updated |
UpdateOptions | Long | 3.5 | Determines how a batch update query will be constructed |
ValidationRule | String | 3.0/3.5 | Contains an expression that must evaluate True for a successful update |
ValidationText | String | 3.0/3.5 | Indicates the message to appear if ValidationRule fails |
Property | Type | Version | Description |
Attributes | Long | 3.0/3.5 | Miscellaneous characteristics of the Relation object |
ForeignTable | String | 3.0/3.5 | Specifies the name of the foreign (referencing) table in a relationship |
Name | String | 3.0/3.5 | Name of this Relation object |
PartialReplica | Boolean | 3.5 | Indicates whether the relation provides a partial replica’s synchronizing rules |
Table | String | 3.0/3.5 | Specifies the primary (referenced) TableDef or Querydef |
Method | Parameters | Returns | Version | Description |
CreateField | [Name], [Type], [Size] | Field | 3.0/3.5 | Creates a new Field object |
CreateIndex | [Name] | Index | 3.0/3.5 | Creates a new Index object |
CreateProperty | [Name], [Type], [Value], [DDL] | Property | 3.0/3.5 | Creates a new user-defined Property object |
OpenRecordset | [Type], [Options] | Recordset | 3.0/3.5 | Creates a new Recordset object |
RefreshLink | Sub | 3.0/3.5 | Updates connection information for an attached table |
Property | Type | Version | Description |
Attributes | Long | 3.0/3.5 | Miscellaneous characteristics of the TableDef object |
ConflictTable | String | 3.0/3.5 | Name of table containing records that conflicted during replica synchronization |
Connect | String | 3.0/3.5 | Data source for the TableDef |
DateCreated | Variant | 3.0/3.5 | Date and time when the table was created |
LastUpdated | Variant | 3.0/3.5 | Date and time when the TableDef was last changed |
Name | String | 3.0/3.5 | Name of the TableDef |
RecordCount | Long | 3.0/3.5 | Number of records |
ReplicaFilter | Variant | 3.5 | Indicates which records to include in a partial replica |
SourceTableName | String | 3.0/3.5 | Name of a linked table’s original source table |
Updatable | Boolean | 3.0/3.5 | Indicates whether the TableDef definition can be changed |
ValidationRule | String | 3.0/3.5 | Expression that must evaluate to True for a successful update |
ValidationText | String | 3.0/3.5 | Message to display if ValidationRule fails |
Method | Parameters | Returns | Version | Description |
BeginTrans | Sub | 3.0/3.5 | Begins a new transaction | |
Close | Sub | 3.0/3.5 | Close the Workspace object | |
CommitTrans | Sub | 3.0/3.5 | Ends the transaction and saves any changes | |
CreateDatabase | Name As String, Connect As String, [Option] | Database | 3.0/3.5 | Creates a new Microsoft Jet database (.mdb) |
CreateGroup | [Name], [PID] | Group | 3.0/3.5 | Creates a new Group object |
CreateUser | [Name], [PID], [Password] | User | 3.0/3.5 | Creates a new User object |
OpenConnection | Name As String, [Options], [ReadOnly], [Connect] | Connection | 3.5 | Opens a connection to a database |
OpenDatabase | Name As String, [Exclusive], [ReadOnly], [Connect] | Database | 3.0/3.5 | Opens a database |
Rollback | Sub | 3.0/3.5 | Undoes any changes since the last BeginTrans |
Property | Type | Version | Description |
DefaultCursorDriver | Long | 3.5 | Selects the ODBC cursor library |
IsolateODBCTrans | Integer | 3.0/3.5 | Indicates whether multiple transactions are isolated (ODBC only) |
LoginTimeout | Long | 3.5 | Number of seconds allowed for logging in to an ODBC database |
Name | String | 3.0/3.5 | Name of this Workspace object |
UserName | String | 3.0/3.5 |
3.141.193.244