Promotic

Object AdoRecordset (ADO Recordset)

Description:
The ADO Recordset object represents a set of records. It is an object implemented from the ADO technology by the Microsoft company. Only the most important properties and methods will be included into this PROMOTIC documentation. The exact description of the see object interface http://msdn.microsoft.com/en-us/library/ms681510(v=VS.85).aspx or http://www.w3schools.com/asp/ado_ref_recordset.asp.

The ADO Recordset object: The AdoRecordset object represents the resulting data of SQL query. The data may consist of arbitrary number of records, where each record of the corresponding AdoRecordset object has the same structure (AdoField objects). The data are represented by a table, where each record corresponds to a row and the columns consist of the AdoField objects.

Current record: One of the records can be selected as current record. It is the one record that is currently being worked with. A wide set of operations refer to the current record. In order to move the current record cursor within the AdoRecordset object many methods can be used, for example MoveFirst, MoveNext, etc. There can be only one selected current record in the AdoRecordset object, or there can be none. When moving through the records one by one (forward or backward), forward by the MoveNext method (or backward by the MovePrevious method), finaly the selected current record will get to the position of last (first) record and the move ends there. The EOF property (BOF) serves for indicating that the cursor reached the end (beginning) of the recordset.

The ADO Record object:
Depending on the specific ADO Provider it is possible, that a single row SQL query result will not be returned in the form of the AdoRecordset object containing a single record, but in the form of the AdoRecord object (represents the single row). Není to ale typické pro nejběžněji užívané ADO Provider. The AdoRecord object is usually returned by explicit operations, when the specific AdoRecord is returned from the existing AdoRecordset object. The AdoRecord object consists of multiple AdoField objects, the same way as the AdoRecordset object. The difference is that the methods for moving the current record position are not supported (e.g. MoveFirst). In order to keep the documntation simple, it will be referred only to the commonly returned AdoRecordset object, although in some special cases the system may also return the AdoRecord object.
Properties:
AbsolutePageReturns or sets a value that specifies the page number in the AdoRecordset object.
AbsolutePositionReturns or sets a value that specifies the ordinal position of the current record in the AdoRecordset object.
ActiveCommandReturns the Command object associated with the AdoRecordset object.
ActiveConnectionReturns or sets a definition for a connection if the connection is closed, or the current Connection object if the connection is open.
BOFDetects whether the current record position is before the first record in the AdoRecordset object
BookmarkReturns or sets a bookmark. The bookmark saves the current record position.
CacheSizeReturns or sets the number of records that can be cached.
CursorLocationReturns or sets the location of the cursor service.
CursorTypeReturns or sets the cursor type of the AdoRecordset object.
DataMemberReturns or sets the name of the data member that will be retrieved from the object referenced by the DataSource property.
DataSourceSpecifies an object containing data to be represented as a the AdoRecordset object
EditModeIndicates the editing status of the current record (the ADO EditModeEnum value)
EOFDetects whether the current record position is after the last record in the AdoRecordset object
FieldsReturns the Collection object which contains AdoField objects
FilterReturns or sets a filter for the data in the AdoRecordset object.
IndexReturns or sets the name of the current index in the AdoRecordset object.
LockTypeReturns or sets a value that specifies the type of locking when editing a record in the AdoRecordset object.
MarshalOptionsReturns or sets a value that specifies which records are to be returned to the server.
MaxRecordsReturns or sets the maximum number of records to return from a query to the AdoRecordset object
PageCountReturns the number of pages with data in the AdoRecordset object.
PageSizeReturns or sets the maximum number of records allowed on a single page of the AdoRecordset object.
Pm_LastErrThe numeric error code of the result of the last executed method (property) of the AdoRecordset object
Pm_LastTextErrThe text description of the last executed method (property) of the AdoRecordset object
RecordCountReturns the number of records in the AdoRecordset object
SortReturns or sets the field names in the AdoRecordset to sort on.
SourceSets a string value or the Command object reference, or returns value of the String type that specifies the data source of the AdoRecordset object.
StateDetects whether the AdoRecordset object is open, closed, connecting, executing an asynchronous method or retrieving data
StatusReturns the status of the current record with regard to batch updates or other bulk operations.
StayInSyncReturns or sets whether the reference to the child records will change when the parent record position changes.
Methods:
AddNewBegin of the edit mode for adding a record
CancelCancels an execution.
CancelBatchCancels a batch update.
CancelUpdateEnd of the edit mode of the record, canceling changes
CloneCreates a duplicate of an existing AdoRecordset.
CloseCloses a AdoRecordset.
CompareBookmarksCompares two bookmarks.
DeleteDeletes record in the AdoRecordset object
FindSearch for a record in the AdoRecordset object that satisfies the specified criteria
GetRowsCopies multiple records of the AdoRecordset object into an 2-dimensional array
GetStringReturns a AdoRecordset as a string
MoveMove the current record position in the AdoRecordset object by the specified number of records
MoveFirstMove the current record position to the first record in the AdoRecordset object
MoveLastMove the current record position to the last record in the AdoRecordset object
MoveNextMove the current record position to the next record in the AdoRecordset object
MovePreviousMove the current record position to the previous record of the AdoRecordset object
NextRecordsetClears the current AdoRecordset object and returns the next AdoRecordset object by looping through a series of commands.
OpenOpens a database element that gives you access to records in a table, the results of a query, or to a saved AdoRecordset.
RequeryComplete data read in the AdoRecordset object
ResyncRefreshing the existing data in the AdoRecordset object
SaveSaves the AdoRecordset object into the file or to Stream object.
SeekSearches the index of the AdoRecordset object to find a record that matches the specified values.
SupportsReturns a boolean value that specifies whether the AdoRecordset object supports a specific type of functionality.
UpdateEnd of the edit mode of record, writing changes
UpdateBatchSaves all changes in the AdoRecordset object to the database. Used when working in batch update mode.
See also:
- AdoRecord (object)
- AdoField (object)
- PmaAdo (object)

History:
Pm8.01.00: Created
PROMOTIC 9.0.23 SCADA system documentation MICROSYS, spol. s r.o.

Send page remarkContact responsible person
© MICROSYS, spol. s r. o.