AddRecord (Recordset subroutine): Difference between revisions
m (1 revision) |
m (1 revision) |
||
| Line 1: | Line 1: | ||
{{Template:Recordset:AddRecord subtitle}} | |||
| Line 12: | Line 8: | ||
but it does so for <var>Recordset</var> objects. | but it does so for <var>Recordset</var> objects. | ||
==Syntax== | ==Syntax== | ||
{{Template:Recordset:AddRecord syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
| Line 23: | Line 18: | ||
</td></tr></table> | </td></tr></table> | ||
==Usage | ==Usage notes== | ||
<ul> | <ul> | ||
<li>The lock strength of the <var>Record</var> object being added to the method object | <li>The lock strength of the <var>Record</var> object being added to the method object | ||
must be greater than or equal to the lock strength of the record set being added to. | must be greater than or equal to the lock strength of the record set being added to. | ||
Consequently, <var>AddRecord</var> does not require any new locks &mdash; | Consequently, <var>AddRecord</var> does not require any new locks &amp;mdash; | ||
the record being added must already be locked at an equal | the record being added must already be locked at an equal | ||
or greater strength than the target. | or greater strength than the target. | ||
| Line 64: | Line 59: | ||
%(Record in File customers):currentRecord) | %(Record in File customers):currentRecord) | ||
</p> | </p> | ||
==See also== | |||
{{Template:Recordset:AddRecord footer}} | |||
Revision as of 23:59, 14 April 2011
Add Record object record to a Recordset (Recordset class)
AddRecord adds the record in a Record object to the records in an existing Recordset object. It provides functionality identical to the User Language Place Record statement, but it does so for Recordset objects.
Syntax
recordset:AddRecord( record)
Syntax terms
| %target | A non-null Recordset object variable. |
|---|---|
| recordObject | A non-null Record object, which must have the same file context as %target. |
Usage notes
- The lock strength of the Record object being added to the method object
must be greater than or equal to the lock strength of the record set being added to.
Consequently, AddRecord does not require any new locks &mdash;
the record being added must already be locked at an equal
or greater strength than the target.
Therefore, this method will never cause a record locking conflict.
Within a Recordset, all records are always locked at the same strength (the
lock strength with which the object was created).
In summary, these locking rules are in effect.
Any violation of them results in request cancellation.
- To a Recordset locked at exclusive level, you may add only a record that is locked at exclusive level.
- To a Recordset locked at share level, you may add a record locked at exclusive level or share level.
- To an unlocked Recordset you may add a record locked at any strength (exclusive, share, none).
- If the Record object parameter of AddRecord is null, the request is cancelled.
Example
In the following example, the records where field Paid is greater than field
Charges are placed on a Recordset:
%overPaid is object recordSet in file customers %overpaid = new(share) for each record in file customers if paid gt charges then %overPaid:addRecord(currentRecord) end if end find
With version 6.8 of Sirius Mods and earlier, you must specify the class name or an object variable before the CurrentRecord method name; for example:
%overPaid:addRecord( - %(Record in File customers):currentRecord)