Difference between revisions of "Recordset"
From Lianjapedia
Barrymavin (Talk | contribs) (→Events) |
|||
(24 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
+ | Note: property, method and event names should be referred to in lowercase in case-sensitive scripting languages. | ||
+ | |||
====Properties==== | ====Properties==== | ||
− | This class supports the | + | This class supports the [[:Category:Common_Properties|Common Properties]] plus the following: |
− | {| class="wikitable" | + | {| class="wikitable" width="100%" |
!width="20%"|Property | !width="20%"|Property | ||
!Access (R/RW) | !Access (R/RW) | ||
Line 9: | Line 11: | ||
!width="50%"|Description | !width="50%"|Description | ||
|- | |- | ||
− | |Bof | + | |valign="top"|Bof |
− | |R | + | |valign="top"|R |
− | | | + | |valign="top"|Boolean |
− | | | + | |valign="top"|Whether record pointer is at beginning of dataset |
|- | |- | ||
− | |Eof | + | |valign="top"|Eof |
− | |R | + | |valign="top"|R |
− | | | + | |valign="top"|Boolean |
− | | | + | |valign="top"|Whether record pointer is at end of recordset |
|- | |- | ||
− | | | + | |valign="top"|FieldCount |
− | |R | + | |valign="top"|R |
− | | | + | |valign="top"|Numeric |
− | |Number of fields | + | |Number of fields in the dataset |
|- | |- | ||
|Filter | |Filter | ||
|RW | |RW | ||
− | | | + | |Character |
− | | | + | |Filter expression to restrict records |
|- | |- | ||
|valign="top"|Found | |valign="top"|Found | ||
|valign="top"|R | |valign="top"|R | ||
− | |valign="top"| | + | |valign="top"|Boolean |
− | | | + | |Whether the last seek or find operation found a matching record |
|- | |- | ||
|Index | |Index | ||
|RW | |RW | ||
− | | | + | |Character |
− | | | + | |Name of the index tag |
|- | |- | ||
− | |valign="top"| | + | |valign="top"|NoMatch |
|valign="top"|R | |valign="top"|R | ||
− | |valign="top"| | + | |valign="top"|Boolean |
− | | | + | |Whether the last seek or find operation did not find any matching records |
|- | |- | ||
− | | | + | |RecordCount |
|R | |R | ||
− | | | + | |Numeric |
− | |Number of records | + | |Number of records in the dataset |
|- | |- | ||
− | | | + | |valign="top"|RecordNumber |
− | |R | + | |valign="top"|R |
− | | | + | |valign="top"|Numeric |
− | | | + | |Number of the current record in the dataset |
|- | |- | ||
|} | |} | ||
Line 58: | Line 60: | ||
====Methods==== | ====Methods==== | ||
− | This class supports the | + | This class supports the [[:Category:Common_Methods|Common Methods]] plus the following: |
− | {| class="wikitable" | + | {| class="wikitable" width="100%" |
!width="20%"|Method | !width="20%"|Method | ||
!Args | !Args | ||
!width="50%"|Description | !width="50%"|Description | ||
|- | |- | ||
− | | | + | |valign="top"|AddNew |
− | | | + | |valign="top"|None |
− | | | + | |Adds a new record to the recordset. Field values of the new record can then be modified. Complete the add/modification by calling the update method. |
|- | |- | ||
|Close | |Close | ||
− | | | + | |None |
− | | | + | |Closes the recordset |
|- | |- | ||
|valign="top"|Column | |valign="top"|Column | ||
− | |valign="top"| | + | |valign="top"|columnumber as Numeric |
− | | | + | |valign="top"|Return the value of the specified column in the current record |
|- | |- | ||
− | |Delete | + | |valign="top"|Delete |
− | | | + | |valign="top"|None |
− | |Marks the current record in a table recordset for deletion | + | |valign="top"|Marks the current record in a table recordset for deletion |
|- | |- | ||
− | |Edit | + | |valign="top"|Edit |
− | | | + | |valign="top"|None |
− | | | + | |Puts the current record in recordset in edit mode, prior to field value modification. Complete the modification by calling the update method. |
|- | |- | ||
− | |Execute | + | |valign="top"|Execute |
− | | | + | |command as Character |
− | | | + | |valign="top"|Execute the command |
|- | |- | ||
− | |Fcount | + | |valign="top"|Fcount |
− | | | + | |valign="top"|None |
|Returns the number of fields/columns in the recordset | |Returns the number of fields/columns in the recordset | ||
|- | |- | ||
− | |Fields | + | |valign="top"|Fields |
− | | | + | |valign="top"|[fieldname as Character | fieldnumber as Numeric] |
− | | | + | |valign="top"|Return an object reference to the specified [[Field]] in the current record |
|- | |- | ||
− | |valign="top"| | + | |valign="top"|FindFirst |
− | |valign="top"| | + | |valign="top"|condition as Character |
− | | | + | |Move the record pointer to the first record in the recordset to match the condition |
|- | |- | ||
− | |valign="top"| | + | |valign="top"|FindLast |
− | |valign="top"| | + | |valign="top"|condition as Character |
− | | | + | |Move the record pointer to the last record in the recordset to match the condition |
|- | |- | ||
− | |valign="top"| | + | |valign="top"|FindNext |
− | |valign="top"| | + | |valign="top"|condition as Character |
− | | | + | |Move the record pointer to the next record in the recordset to match the condition |
|- | |- | ||
− | |valign="top"| | + | |valign="top"|FindPrevious |
− | |valign="top"| | + | |valign="top"|condition as Character |
− | | | + | |Move the record pointer to the previous record in the recordset to match the condition |
|- | |- | ||
− | | | + | |valign="top"|MoveBookmark |
− | | | + | |valign="top"|bookmark as Numeric |
− | | | + | |valign="top"|Move bookmark to the specified record number in the recordset |
|- | |- | ||
− | |Movefirst | + | |valign="top"|Movefirst |
− | | | + | |valign="top"|None |
− | |Move record pointer to first record in the recordset | + | |valign="top"|Move record pointer to first record in the recordset |
|- | |- | ||
− | |Movelast | + | |valign="top"|Movelast |
− | | | + | |valign="top"|None |
− | |Move record pointer to last record in the recordset | + | |valign="top"|Move record pointer to last record in the recordset |
|- | |- | ||
− | |Movenext | + | |valign="top"|Movenext |
− | | | + | |valign="top"|None |
− | |Move record pointer to next record in the recordset | + | |valign="top"|Move record pointer to next record in the recordset |
|- | |- | ||
− | |Moveprevious | + | |valign="top"|Moveprevious |
− | | | + | |valign="top"|None |
− | |Move record pointer to previous record in the recordset | + | |valign="top"|Move record pointer to previous record in the recordset |
|- | |- | ||
|valign="top"|Moverelative | |valign="top"|Moverelative | ||
− | |valign="top"| | + | |valign="top"|numrecords as Numeric |
− | |Move record pointer by | + | |Move record pointer by numrecords records: forwards if numrecords is positive, backwards if numrecords is negative |
|- | |- | ||
− | | | + | |valign="top"|RecCount |
− | | | + | |valign="top"|None |
− | | | + | |Return the number of records in the recordset |
|- | |- | ||
− | | | + | |RecNo |
− | | | + | |None |
− | | | + | |Return the current record number in the recordset |
|- | |- | ||
|Requery | |Requery | ||
− | | | + | |None |
− | | | + | |Requery the recordset |
|- | |- | ||
− | |Seek | + | |valign="top"|Seek |
− | | | + | |valign="top"|[operator as Character,] key as Character |
− | | | + | |valign="top"|Search the index for the first record to match the key. The operator (=, >, <) may optionally be specified. |
|- | |- | ||
− | |SQLExecute | + | |valign="top"|SQLExecute |
− | | | + | |sqlcommand as Character |
− | | | + | |valign="top"|Execute the SQL command |
|- | |- | ||
− | |Update | + | |valign="top"|Update |
− | | | + | |valign="top"|None |
− | | | + | |Completes an addnew or edit method operation |
|- | |- | ||
|} | |} | ||
− | |||
− | |||
− | + | [[Category:Documentation]] | |
− | + | [[Category:Framework Classes]] | |
− | + | [[Category:Working with Data]] | |
− | + | ||
− | + | ||
− | + |
Latest revision as of 11:28, 10 April 2019
Note: property, method and event names should be referred to in lowercase in case-sensitive scripting languages.
Properties
This class supports the Common Properties plus the following:
Property | Access (R/RW) | Value | Description |
---|---|---|---|
Bof | R | Boolean | Whether record pointer is at beginning of dataset |
Eof | R | Boolean | Whether record pointer is at end of recordset |
FieldCount | R | Numeric | Number of fields in the dataset |
Filter | RW | Character | Filter expression to restrict records |
Found | R | Boolean | Whether the last seek or find operation found a matching record |
Index | RW | Character | Name of the index tag |
NoMatch | R | Boolean | Whether the last seek or find operation did not find any matching records |
RecordCount | R | Numeric | Number of records in the dataset |
RecordNumber | R | Numeric | Number of the current record in the dataset |
Methods
This class supports the Common Methods plus the following:
Method | Args | Description |
---|---|---|
AddNew | None | Adds a new record to the recordset. Field values of the new record can then be modified. Complete the add/modification by calling the update method. |
Close | None | Closes the recordset |
Column | columnumber as Numeric | Return the value of the specified column in the current record |
Delete | None | Marks the current record in a table recordset for deletion |
Edit | None | Puts the current record in recordset in edit mode, prior to field value modification. Complete the modification by calling the update method. |
Execute | command as Character | Execute the command |
Fcount | None | Returns the number of fields/columns in the recordset |
Fields | [fieldname as Character | fieldnumber as Numeric] | Return an object reference to the specified Field in the current record |
FindFirst | condition as Character | Move the record pointer to the first record in the recordset to match the condition |
FindLast | condition as Character | Move the record pointer to the last record in the recordset to match the condition |
FindNext | condition as Character | Move the record pointer to the next record in the recordset to match the condition |
FindPrevious | condition as Character | Move the record pointer to the previous record in the recordset to match the condition |
MoveBookmark | bookmark as Numeric | Move bookmark to the specified record number in the recordset |
Movefirst | None | Move record pointer to first record in the recordset |
Movelast | None | Move record pointer to last record in the recordset |
Movenext | None | Move record pointer to next record in the recordset |
Moveprevious | None | Move record pointer to previous record in the recordset |
Moverelative | numrecords as Numeric | Move record pointer by numrecords records: forwards if numrecords is positive, backwards if numrecords is negative |
RecCount | None | Return the number of records in the recordset |
RecNo | None | Return the current record number in the recordset |
Requery | None | Requery the recordset |
Seek | [operator as Character,] key as Character | Search the index for the first record to match the key. The operator (=, >, <) may optionally be specified. |
SQLExecute | sqlcommand as Character | Execute the SQL command |
Update | None | Completes an addnew or edit method operation |