C.1.12- The Recordset Object

Name

Returns

Description

AddNew

Creates a new record for an updateable Recordset object.

Cancel

Cancels execution of a pending asynchronous Open operation.

CancelBatch

Cancels a pending batch update.

CancelUpdate

Cancels any changes made to the current record, or to a new record prior to calling the Update method.

Clone

Recordset

Creates a duplicate Recordset object from an existing Recordset object.

Close

Closes the Recordset object and any dependent objects.

CompareBookmarks

Compare
Enum

Compares two bookmarks and returns an indication of the relative values.

Delete

Deletes the current record or group of records.

Find

Searches the recordset for a record that matches the specified criteria.

GetRows

Variant

Retrieves multiple records of a Recordset object into an array.

GetString

String

Returns a recordset as a string.

Move

Moves the position of the current record in a recordset.

MoveFirst

Moves the position of the current record to the first record in the recordset.

MoveLast

Moves the position of the current record to the last record in the recordset.

MoveNext

Moves the position of the current record to the next record in the recordset.

MovePrevious

Moves the position of the current record to the previous record in the recordset.

Name

Returns

Description

NextRecordset

Recordset

Clears the current Recordset object and returns the next recordset by advancing through a series of commands.

Open

Opens a recordset.

Requery

Updates the data in a Recordset object by re-executing the query on which the object is based.

Resync

Refreshes the data in the current Recordset object from the underlying database.

Save

Saves the recordset to a file.

Seek

Searches the recordset index to locate a value

Supports

Boolean

Determines whether a specified Recordset object supports particular functionality.

Update

Saves any changes made to the current Recordset object.

UpdateBatch

Writes all pending batch updates to disk.

Name

Returns

Description

AbsolutePage

PositionEnum

Specifies in which page the current record resides.

AbsolutePosition

PositionEnum

Specifies the ordinal position of a Recordset object's current record.

ActiveCommand

Object

Indicates the Command object that created the associated Recordset object. Read-only.

ActiveConnection

Variant

Indicates to which Connection object the specified Recordset object currently belongs.

BOF

Boolean

Indicates whether the current record is before the first record in a Recordset object. Read-only.

Bookmark

Variant

Returns a bookmark that uniquely identifies the current record in a Recordset object, or sets the current record to the record identified by a valid bookmark.

Name

Returns

Description

CacheSize

Long

Indicates the number of records from a Recordset object that are cached locally in memory.

CursorLocation

CursorLocation
Enum

Sets or returns the location of the cursor engine.

CursorType

CursorType
Enum

Indicates the type of cursor used in a Recordset object.

DataMember

String

Specifies the name of the data member to retrieve from the object referenced by the DataSource property. Write-only.

DataSource

Object

Specifies an object containing data to be represented as a Recordset object. Write-only.

EditMode

EditModeEnum

Indicates the editing status of the current record. Read-only.

EOF

Boolean

Indicates whether the current record is after the last record in a Recordset object. Read-only.

Fields

Fields

Contains all of the Field objects for the current Recordset object.

Filter

Variant

Indicates a filter for data in the Recordset.

Index

String

Identifies the name of the index currently being used.

LockType

LockTypeEnum

Indicates the type of locks placed on records during editing.

MarshalOptions

MarshalOptions
Enum

Indicates which records are to be marshaled back to the server.

MaxRecords

Long

Indicates the maximum number of records to return to a Recordset object from a query. Default is zero (no limit).

PageCount

Long

Indicates how many pages of data the Recordset object contains. Read-only.

PageSize

Long

Indicates how many records constitute one page in the recordset.

Properties

Properties

Contains all of the Property objects for the current Recordset object.

Name

Returns

Description

RecordCount

Long

Indicates the current number of records in the Recordset object. Read-only.

Sort

String

Specifies one or more field names the recordset is sorted on, and the direction of the sort.

Source

String

Indicates the source for the data in a Recordset object.

State

Long

Indicates whether the recordset is open, closed, or whether it is executing an asynchronous operation. Read-only.

Status

Integer

Indicates the status of the current record with respect to match updates or other bulk operations. Read-only.

StayInSync

Boolean

Indicates, in a hierarchical Recordset object, whether the parent row should change when the set of underlying child records changes. Read-only.

Name

Description

EndOfRecordset

Fired when there is an attempt to move to a row past the end of the recordset.

FetchComplete

Fired after all the records in an asynchronous operation have been retrieved into the recordset.

FetchProgress

Fired periodically during a length asynchronous operation, to report how many rows have currently been retrieved.

FieldChangeComplete

Fired after the values of one or more Field objects have been changed.

MoveComplete

Fired after the current position in the recordset changes.

RecordChangeComplete

Fired after one or more records change.

RecordsetChangeComplete

Fired after the recordset has changed.

WillChangeField

Fired before a pending operation changes the value of one or more Field objects.

WillChangeRecord

Fired before one or more rows in the recordset change.

Name

Description

WillChangeRecordset

Fired before a pending operation changes the recordset.

WillMove

Fired before a pending operation changes the current position in the recordset.