Record Object (Versions 2.5, 2.6)
Dim record As ADODB.Record

The Record object represents either a single row within a Recordset object or a resource in a semistructured data source, such as a file directory.

Record.ActiveConnection Property (Versions 2.5, 2.6)

Record.ActiveConnection = ConnectionString
Set Record.ActiveConnection = ConnectionObject
 

The ActiveConnection property indicates to which Connection object the current Record object belongs.

Datatype

String or Variant (containing the current Connection object)

 
Description

The ActiveConnection property of the Record object is both read- and write-enabled while the Record object is closed and read-only once it is opened. This property can be set to either a connection string or a Connection object and returns a Connection object when it is read.

If the Record object was opened from an existing Record object or a Recordset object, then the Record object gains its Connection object from this object. If the Record object is opened by using a URL, a Connection object is automatically created for the Record object and is accessible from the ActiveConnection property.

 
See Also

Record.Open Method

 
Record.Cancel Method (Versions 2.5, 2.6)

record.Cancel
 

The Cancel method cancels an asynchronous operation for the Record object.

Description

The Cancel method can be called to cancel an asynchronous operation of the Record object invoked by the CopyRecord, DeleteRecord, MoveRecord, and Open methods.

 
See Also

Record.CopyRecord Method, Record.DeleteRecord Method, Record.MoveRecord Method, Record.Open Method

 
Record.Close Method (Versions 2.5, 2.6)

record.Close
 

The Close method closes an opened Record object.

Description

The Close method can be called only on an open Record object. After calling the Close method, the Open method can be called again to reopen the Record object. Calling the Close method releases any resources allocated to the Record object.

 
Record.CopyRecord Method (Versions 2.5, 2.6)

record.CopyRecord (Source, _
Destination, _
UserName, _
Password, _
Options, _
Async) As String
 

The CancelBatch is a member method of the Recordset object that cancels the currently pending batch update.

Arguments
Source (String)

Optional. Indicates the URL of a resource to be copied. If this argument is omitted, then the resource represented by the current Record object is copied.

Destination (String)

Optional. Represents a URL value that indicates where the resource will be copied to.

UserName (String)

Optional. Indicates, if necessary, the username that will be used to access the resource indicated by the Destination argument.

Password (String)

Optional. Indicates, if necessary, the password to verify the UserName argument.

Options (CopyRecordOptionsEnum)

Optional. Indicates the behavior of the copy operation. The default value for this argument is adCopyUnspecified.

Async (Boolean)

Optional. Indicates whether this operation should be executed asynchronously.

 
Returns

String

 
Description

By default, the CopyRecord method will not overwrite a resource that already exists. To force the replacement of the destination resource, use the adCopyOverWrite option.

By default, the CopyRecord method will copy all subdirectories and files beneath the source resource unless the adCopyNonRecursive option is specified.

If the source and the destination resources are identical, an error will occur. If the destination resource is a child of the source resource, the operation will never complete.

The return value, although provider-specific, is usually the name of the destination resource.

 
See Also

CopyRecordOptionsEnum Enumeration

 
Record.DeleteRecord Method (Versions 2.5, 2.6)

record.DeleteRecord Source, Async
 

The DeleteRecord method deletes the resource represented by the current Record object, or another if specified.

Arguments
Source (String)

Optional. Specifies which resource to delete. If this argument is omitted, the resource represented by the current Record object will be deleted.

Async (Boolean)

Optional. Indicates whether this operation should be executed asynchronously.

 
Description

The DeleteRecord method deletes all children resources of the current resource as well.

The Record object should be closed immediately after calling the DeleteRecord method because its behavior would be unpredictable. At the very least, an error will occur when trying to work with a Record object that represents a deleted resource.

If the Record object was created from a Recordset object, you should either close and reopen the Recordset object or call Resync or Requery for the resource to be removed from it.

 
See Also

Recordset.Open Method, Recordset.Requery Method, Recordset.Resync Method

 
Record.Fields Collection (Versions 2.5, 2.6)

record.Fields
 

The Fields collection contains individual Field objects for the current Record object.

Datatype

Fields (Collection object)

 
Description

The Fields collection contains multiple Field objects for the current Record object. There are two special Field objects, adDefaultStream and adRecordURL,that can be accessed by specifying the FieldEnum enumeration. One returns the default string for the current Record object, and the other returns the URL.

Field objects can be added to the collection either by calling the Field.Append method or by referencing a Field by name that is not already part of the collection. Calling the Field.Update method will add the field to the collection, if possible, within the data source. Until this moment, the Field.Status property will return adFieldPendingInsert.

 
See Also

Field.Append Method, Field.Update Method, FieldEnum Enumeration

 
Record.GetChildren Method (Versions 2.5, 2.6)

Set recordset = record.GetChildrean
 

The GetChildren method returns the children of a collection Record object in the form of a Recordset object.

Returns

Recordset object

 
Description

The GetChildren method returns a Recordset object containing children of the current Record object. Each record within the returned Recordset object represents a single resource that is a child of the resource represented by the associated Record object.

 
Record.Mode Property (Versions 2.5, 2.6)

record.Mode = ConnectModeEnum
 

The Mode property indicates the permissions for modifying data within a Record object.

Datatype

ConnectModeEnum

 
Description

The default value for the Mode property of a Record object is adModeRead. The Mode property is read- and write-enabled while the Record object is closed, but read-only once it is opened.

 
See Also

ConnectModeEnum Enumeration

 
Record.MoveRecord Method (Versions 2.5, 2.6)

record.MoveRecord (Source, _
Destination, _
UserName, _
Password, _
Options, _
Async) As String
 

The MoveRecord method moves a resource to another location.

Arguments
Source (String)

Optional. Indicates the URL of a resource to be moved. If this argument is omitted, then the resource represented by the current Record object is moved.

Destination (String)

Optional. Represents a URL value that indicates where the resource will be moved.

UserName (String)

Optional. Indicates, if necessary, the username that will be used to access the resource indicated by the Destination argument.

Password (String)

Optional. Indicates, if necessary, the password to verify the UserName argument.

Options (CopyRecordOptionsEnum)

Optional. Indicates the behavior of the move operation. The default value for this argument is adMoveUnspecified.

Async (Boolean)

Optional. Indicates whether this operation should be executed asynchronously.

 
Returns

String

 
Description

By default, the MoveRecord method does not overwrite a resource that already exists. To force the replacement of the destination resource, use the adCopyOverWrite option. All hypertext links in the file are automatically updated unless otherwise specified in the Options argument.

If the source and the destination resources are identical, an error will occur.

If the Record object was created from a Recordset object, you should close and reopen the Recordset object or call Resync or Requery for the resource to be removed from the recordset.

Not all properties of the Record object will be automatically repopulated -- to do this, close and reopen the Record object.

The return value, although provider-specific, is usually the name of the destination resource.

 
See Also

MoveRecordOptionsEnum Enumeration, Record.Close Method, Record.Open Method, Recordset.Open Method, Recordset.Requery Method, Recordset.Resync Method

 
Record.Open Method (Versions 2.5, 2.6)

record.Open (Source, _
ActiveConnection, _
Mode, _
CreateOptions, _
Options, _
UserName, _
Password)
 

The Open method opens an individual record in a recordset or a resource within a data source.

Arguments
Source (Variant)

Optional. Indicates the source of the resource to open. This can be a URL, a Command object returning a single row, an open Recordset object, or a String containing a SQL statement or a table name.

ActiveConnection (Variant)

Optional. Indicates the connection to the data source by either a connection string or an open Connection object.

Mode (ConnectModeEnum)

Optional. Indicates the access permissions to open the Record object with. The default value is adModeUnknown.

CreateOptions (CreateModeEnum)

Optional. This argument is used only when the Source argument represents a URL. This argument can be used to indicate whether to open an existing resource or to create a new one. The default value for this argument is adFailIfNotExist.

Options (RecordOpenOptionsEnum)

Optional. Can contain multiple RecordOpenOptionsEnum enumeration values that indicate special options for opening the Record object. The default value for this method is adOpenRecordUnspecified.

UserName (String)

Optional. Indicates, if necessary, the username that will be used to access the resource indicated by the source argument.

Password (String)

Optional. Indicates, if necessary, the password to verify the UserName argument.

 
Description

If the Record object represents a resource that cannot be represented by a URL, then the ParentURL property and the adRecordURL default field both return Null.

 
See Also

ConnectModeEnum Enumeration, RecordCreateOptionsEnum Enumeration, RecordOpenOptionsEnum Enumeration

 
Record.ParentURL Property (Versions 2.5, 2.6)

record.ParentURL = ParentURL
 

The ParentURL is used to indicate the parent record of the current Record object by means of an absolute URL.

Datatype

String

 
Description

The ParentURL property indicates the parent resource of the current resource represented by the Record object. This property is read-only.

The ParentURL can be Null if there is no parent for the current resource represented by the Record object or if the resource cannot be expressed in terms of a URL.

 
Record.Properties Collection (Versions 2.5, 2.6)

record.Properties
 

The Properties collection contains characteristics specific to the Record object for the currently used provider.

Datatype

Properties (Collection object)

 
Description

The Properties collection class contains a Property class instance for each property specific to the Record object for the data provider.

 
Record.RecordType Property (Versions 2.5, 2.6)

record.RecordType = RecordTypeEnum
 

The RecordType property indicates the type of the current record.

Datatype

RecordTypeEnum

 
Description

The RecordType property is read-only; it indicates the type of the current Record object.

 
See Also

RecordTypeEnum Enumeration

 
Record.Source Property (Versions 2.5, 2.6)

Set record.Source = object
 

The Source property indicates from which object the Record object is created.

Datatype

Variant

 
Description

The Source property is read-only when the Record object is open, but read- and write-enabled while it is closed.

The Source property can be set to a Recordset or Command object. If the Source property is set to a Recordset object, the Record object will be opened based upon the current record of the Recordset object. If the Source property is set to a Command object, the Command object must return a single row.

If the ActiveConnection property is also set, then the Source property must be set to an object that is within the connection's scope.

The Source property returns the Source argument of the Record.Open method.

 
See Also

Record.ActiveConnection Property, Record.Open Method

 
Record.State Property (Versions 2.5, 2.6)

state = record.State
 

The State property indicates the current state of the Record object.

Datatype

Long (ObjectStateEnum)

 
Description

The read-only State property returns a Long value that can be evaluated as an ObjectStateEnum enumeration value. The default value for the Record object is closed (adStateClosed).

For the Record object, the State property can return multiple values when the object is executing an operation asynchronously (i.e., adStateOpen and adStateExecuting).

 
See Also

ObjectStateEnum Enumeration