Recordset

The ADO Recordset object is used to contain the set of data extracted from a database.

The Recordset object is composed of records (which are also referred to as rows) and of fields (which are also referred to as columns).

The Recordset object should be considered to be the heart of ADO. Via this object, we can select desired data and change the data with additions, deletions, and updates. Equally important is the ability to move around inside the database. In fact, the Recordset object is blessed with an extremely comprehensive selection of properties, collections, methods, and events that allow extensive manipulation of the retrieved data and interpretation of the operational environment. However, the functionality of the provider may impose limitations. For example, some properties may not be available to the Recordset object depending on which provider is being accessed. You can use the Supports method to predetermine if a Recordset object will support a specific type of functionality.

Only the Connection and Recordset objects have events. Note that only the Visual Basic, Visual C++, and Visual J++ languages can handle these events. You cannot handle an event using the VBScript or JScript scripting languages.

Properties

AbsolutePage

Syntax: PositionEnum = recordsetobject.AbsolutePage
recordsetobject.AbsolutePage = PositionEnum
long = recordsetobject.AbsolutePage
recordsetobject.AbsolutePage = long

Sets or returns a long value that is the current page number in the Recordset object,or the PositionEnum value (either BOF, EOF, or empty).

AbsolutePosition

Syntax: PositionEnum = recordsetobject.AbsolutePosition
recordsetobject.AbsolutePosition = PositionEnum
long = recordsetobject.AbsolutePosition
recordsetobject.AbsolutePosition = long

Sets or returns a long value that is the ordinal position of the cursor.

ActiveCommand

Syntax: Set commandobject = recordsetobject. ActiveCommand

Returns a variant that is the Command object associated with the Recordset object.

ActiveConnection

Syntax: Set recordsetobject.ActiveConnection = variant
Set variant = recordsetobject.ActiveConnection
recordsetobject.AbsoluteConnection = string
string = recordsetobject.AbsoluteConnection

Sets or returns a variant defining the Connection object to which the Recordsetbelongs, or returns a string value if there is no connection.

BOF

Syntax: Boolean = recordsetobject.BOF

Returns a Boolean value indicating if the current record position is before the first record.

Bookmark

Syntax: variant = recordsetobject.Bookmark
recordsetobject.Bookmark = variant

Sets or returns a variant value that uniquely defines the position of a record in a recordset.

CacheSize

Syntax: long = recordsetobject.CacheSize
recordsetobject.CacheSize = long

Sets or returns a long value that is the number of records that are cached or are allowed to be cached.

CursorLocation

Syntax: CursorLocationEnum = recordsetobject.CursorLocation
recordsetobject.CursorLocation = CursorLocationEnum

Sets or returns a long value that is a CursorLocationEnum value which defines the location of the cursor engine (server-side or client-side).

CursorType

Syntax: CursorTypeEnum = recordsetobject.CursorType
recordsetobject.CursorType = CursorTypeEnum

Sets or returns a CursorTypeEnum value that defines the type of cursor being used.

DataMember

Syntax: string = recordsetobject.DataMember
recordsetobject.DataMember = string

Sets or returns a string value that names the data member referenced by the DataSource property.

DataSource

Syntax: Set object = recordsetobject.DataSource
Set recordsetobject.DataSource = object

Specifies the object containing the data member that will be represented as a Recordset object.

EditMode

Syntax: EditModeEnum = recordsetobject.EditMode

Returns an EditModeEnum value that defines the editing status of the current record.

EOF

Syntax: Boolean = recordsetobject.EOF

Returns a Boolean value indicating if the current record position is after the last record.

Filter

Syntax: variant = recordsetobject.Filter
recordsetobject.Filter = variant

Sets or returns a variant value that is either a string, array of bookmarks, or a FilterGroupEnum value used to filter data.You also use this property to turn an existing Filter off.

Index

Syntax: string = recordsetobject.Index
recordsetobject.Index = string

Sets or returns a string value that is the name of the index in effect.

LockType

Syntax: LockTypeEnum = recordsetobject.LockType
recordsetobject.LockType = LockTypeEnum

Sets or returns a LockTypeEnum value that defines the type of locks that arein effect while editing records.

MarshalOptions

Syntax: MarshalOptionsEnum = recordsetobject.MarshalOptions
recordsetobject.MarshalOptions = MarshalOptionsEnum

Sets or returns a MarshalOptionEnum value that specifies which records are to betransferred (marshaled) back to the server.

MaxRecords

Syntax: long = recordsetobject.MaxRecords
recordsetobject.MaxRecords = long

Sets or returns a long value that specifies the maximum number of records that can be returned to a Recordset object as the result of a query.

PageCount

Syntax: long = recordsetobject.PageCount

Returns a long value that is the number of pages contained in a Recordset object.

PageSize

Syntax: long = recordsetobject.PageSize
recordsetobject.PageSize = long

Sets or returns a long value that specifies how many records are on one page.

RecordCount

Syntax: long = recordsetobject.RecordCount

Returns a long value that is the count of how many records are in a Recordset
object.

Sort

Syntax: string = recordsetobject.Sort
recordsetobject.Sort = string

Sets or returns a string value that is a comma-delineated list of the names of which fields in the Recordset to sort.After each name, you can optionally add a blank space and the keywords ASC or DESC to designate the sort direction.

Source

Syntax: string = recordsetobject.Source
recordsetobject.Source = string
Set recordsetobject.Source = variant

Sets or returns a string value that defines the data source for a Recordset object.

State

Syntax: ObjectStateEnum = recordsetobject.State

Returns a long value describing if the Recordset object is open, closed, or inthe process of connecting, executing, or retrieving.

Status

Syntax: RecordStatusEnum = recordsetobject.Status

Returns a sum of one or more RecordStatusEnum values describing the status of the current record.

StayInSync

Syntax: Boolean = recordsetobject.StayInSync
recordsetobject.StayInSync = Boolean

For a hierarchical Recordset object, sets or returns a Boolean value defining whether the reference to the underlying child record, called the chapter, needs updating.

Methods

AddNew

Syntax: recordsetobject.AddNew FieldList, Values

Used to create a new record.

Cancel

Syntax: recordsetobject.Cancel

Cancels the execution of a pending Open call.

CancelBatch

Syntax: recordsetobject.CancelBatch AffectRecords

Used to cancel a pending batch update.You must be in batch update mode.

CancelUpdate

Syntax: recordsetobject.CancelUpdate

Used to cancel any changes made to the current row or to cancel the addition of a new row to a Recordset.This must be done before performing an Update.

Clone

Syntax: Set recordsetobject_clone = recordsetobject.Clone (LockType)

Creates a duplicate copy of a Recordset object by copying an existing Recordset object.

Close

Syntax: recordsetobject.Close

Closes a Recordset object.

CompareBookmarks

Syntax: CompareEnum = recordsetobject.CompareBookmarks (Bookmark1, Bookmark2)

Returns a CompareEnum value that compares the relative rowposition of two bookmarks in the same Recordset object.

Delete

Syntax: recordsetobject.Delete AffectRecords

Deletes the current record, a group of records, or all records.

Find

Syntax: recordsetobject.Find Criteria, SkipRecords, SearchDirection, Start

Searches for a row in a Recordset that matches the given criteria.

GetRows

Syntax: variant = recordsetobject.GetRows (Rows, Start, Fields)

Used to copy either all or a specified number of records into a two-dimensional array.

GetString

Syntax: string = recordsetobject.GetString (StringFormat, NumRows, ColumnDelimiter, RowDelimiter, NullExpr)

Returns the specified Recordset as a string.

Move

Syntax: string = recordsetobject.Move (NumRecords, Start )

Moves the position of the current record pointer.

MoveFirst

Syntax: recordsetobject.MoveFirst

Moves the position of the current record pointer to the first record.

MoveLast

Syntax: recordsetobject.MoveLast

Moves the position of the current record pointer to the last record.

MoveNext

Syntax: recordsetobject.MoveNext

Moves the position of the current record pointer forward to the next record.

MovePrevious

Syntax: recordsetobject.MovePrevious

Moves the position of the current record pointer back to the previous record.

NextRecordset

Syntax: Set recordsetobject = recordsetobject.NextRecordset (RecordsAffected)

Clears the current Recordset object and returns the next Recordset object.

Open

Syntax: recordsetobject.Open Source, ActiveConnection, CursorType, LockType, Options

When used on a Recordset object, this opens a cursor that is used to navigate through records.

Requery

Syntax: recordsetobject.Requery Options

Used to update (refresh) the data in a Recordset object.This is essentially equivalent to a Close followed by an Open.

Resync

Syntax: recordsetobject.Resync AffectRecords, ResyncValues

Refreshes the data in the current Recordset object by re-synchronizing records with the underlying (original) database.

Save

Syntax: recordsetobject.save Destination, PersistFormat

Saves the Recordset to a file or Stream object.

Seek

Syntax: recordsetobject.Seek KeyValues, SeekOption

Uses the index of a Recordset to locate a specified row.

Supports

Syntax: Boolean = recordsetobject.Supports (CursorOptions)

Returns a Boolean value that indicates whether or not a Recordset object willsupport a specific type of functionality.

Update

Syntax: Boolean = recordsetobject.Update (Fields, Values)

Used to save any changes made to the current row of a Recordset object.

UpdateBatch

Syntax: recordsetobject.UpdateBatch (AffectRecords)

Writes all pending batch updates to the underlying database.

Collections

Fields: The Fields Collection is a collection of all of the Field objects associated with a specific Record object.
Properties: The Properties Collection is a collection of Property objects. Each Property object contains a single piece of information, called a dynamic property, about the database provider. By referring to the Properties Collection, each connection to a provider can be tailored specifically by ADO to suit the exact needs of that provider.