RemoveRecord (Recordset subroutine): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 12: Line 12:
<p class="syntax">%target:RemoveRecord(recordObject)
<p class="syntax">%target:RemoveRecord(recordObject)
</p>
</p>
===Syntax Terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%target</th>
<tr><th>%target</th>

Revision as of 17:21, 13 April 2011

<section begin=dpl_desc/><section end=dpl_desc/>

RemoveRecord is a member of the Recordset class.

RemoveRecord removes the record in a Record object from the records in an existing Recordset object. It provides functionality identical to the User Language Remove Record statement, but it does so for Recordset objects.

Syntax

%target:RemoveRecord(recordObject)

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

  • Since RemoveRecord never adds a record to a Recordset, there are no lock strength requirements for the method object or the input object.
  • If the Record object argument of RemoveRecord is null, the request is cancelled.

Example

In the following example, records not meeting a certain criterion are removed from a Recordset:

%mailList is object recordSet in file customers find records to %mailList status = 'ACTIVE' end find for each record in %mailList if totalPurchase lt 100 then %mailList:removeRecord(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:

%mailList:removeRecord( -  %(Record in File customers):currentRecord)