RemoveRecord (Recordset subroutine) - Revision history

DCameron at 10:28, 10 September 2013

2013-09-10T10:28:11Z

← Older revision		Revision as of 10:28, 10 September 2013
Line 24:		Line 24:

	<li>If the <var>Record</var> object argument of <var>RemoveRecord</var> is null, the request is cancelled.		<li>If the <var>Record</var> object argument of <var>RemoveRecord</var> is null, the request is cancelled.

			<li>Once a record has been removed from a recordset via RemoveRecord, the record data can no longer be accessed within the recordset context.
	</ul>		</ul>

JAL at 23:47, 6 November 2012

2012-11-06T23:47:24Z

← Older revision		Revision as of 23:47, 6 November 2012
Line 7:		Line 7:
	==Syntax==		==Syntax==
	{{Template:Recordset:RemoveRecord syntax}}		{{Template:Recordset:RemoveRecord syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>~~%target~~</th>		<tr><th>recordset</th>
	<td>A non-null <var>Recordset</var> object variable.		<td>A non-null <var>Recordset</var> object variable.
	</td></tr>		</td></tr>
	~~<tr><th>recordObject</th>~~
	~~<td>A non-null <var>Record</var> object, which must have the same file context as <code>%target</code>.~~

	</td></tr></table>		<tr><th>record</th>
			<td>A non-null <var>Record</var> object, which must have the same file context as <var class="term">recordset</var>.</td></tr>
			</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>Since <var>RemoveRecord</var> never adds a record to a <var>Recordset</var>, there are no lock		<li>Since <var>RemoveRecord</var> never adds a record to a <var>Recordset</var>, there are no lock
	strength requirements for the method object or the input object.		strength requirements for the method object or the input object.

	<li>If the <var>Record</var> object argument of <var>RemoveRecord</var> is null, the request is cancelled.		<li>If the <var>Record</var> object argument of <var>RemoveRecord</var> is null, the request is cancelled.
	</ul>		</ul>

	==Example==		==Example==

	In the following example, records not meeting		In the following example, records not meeting
	a certain criterion are removed from a <var>Recordset</var>:		a certain criterion are removed from a <var>Recordset</var>:
	<p class="code"> %mailList is object recordSet in file customers		<p class="code">%mailList is object recordSet in file customers
	find records to %mailList		find records to %mailList
	status = 'ACTIVE'		status = 'ACTIVE'
	end find		end find

	for each record in %mailList		for each record in %mailList
	if totalPurchase lt 100 then		if totalPurchase lt 100 then
	%mailList:removeRecord(currentRecord)		%mailList:removeRecord(currentRecord)
	end if		end if
	end find		end find
	</p>		</p>
	With version 6.8 of <var class="product">Sirius Mods</var> and earlier, you must specify the		With version 6.8 of <var class="product">Sirius Mods</var> and earlier, you must specify the
	class name or an object variable before the <var>CurrentRecord</var> method name; for example:		class name or an object variable before the <var>CurrentRecord</var> method name; for example:
	<p class="code"> %mailList:removeRecord( -		<p class="code">%mailList:removeRecord( %(Record in File customers):currentRecord )
	%(Record in File customers):currentRecord)
	</p>		</p>

	==See also==		==See also==
	{{Template:Recordset:RemoveRecord footer}}		{{Template:Recordset:RemoveRecord footer}}

DmeWiccan: 1 revision

2011-04-14T23:59:07Z

1 revision

← Older revision	Revision as of 23:59, 14 April 2011
(No difference)

JALWiccan: 1 revision

2011-04-14T23:59:05Z

1 revision

← Older revision		Revision as of 23:59, 14 April 2011
Line 1:		Line 1:
	~~<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>~~		{{Template:Recordset:RemoveRecord subtitle}}
	~~[[Category~~:Recordset ~~methods\|RemoveRecord subroutine]]~~
	~~<p>~~
	~~<var>~~RemoveRecord~~</var> is a member of the <var>[[Recordset class\|Recordset]]</var> class.~~
	~~</p>~~

	<var>RemoveRecord</var> removes the record in a <var>Record</var> object from the records		<var>RemoveRecord</var> removes the record in a <var>Record</var> object from the records
Line 10:		Line 6:
	<var class="product">User Language</var> <var>Remove Record</var> statement, but it does so for <var>Recordset</var> objects.		<var class="product">User Language</var> <var>Remove Record</var> statement, but it does so for <var>Recordset</var> objects.
	==Syntax==		==Syntax==
	~~<p class="syntax">%target~~:RemoveRecord~~(recordObject)~~		{{Template:Recordset:RemoveRecord syntax}}
	~~</p>~~
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
Line 21:		Line 16:

	</td></tr></table>		</td></tr></table>
	==Usage ~~Notes~~==		==Usage notes==
	<ul>		<ul>
	<li>Since <var>RemoveRecord</var> never adds a record to a <var>Recordset</var>, there are no lock		<li>Since <var>RemoveRecord</var> never adds a record to a <var>Recordset</var>, there are no lock
Line 47:		Line 42:
	%(Record in File customers):currentRecord)		%(Record in File customers):currentRecord)
	</p>		</p>
			==See also==
			{{Template:Recordset:RemoveRecord footer}}

JALWiccan: 1 revision

2011-04-13T17:21:30Z

1 revision

← Older revision	Revision as of 17:21, 13 April 2011
(No difference)

Admin: 1 revision

2011-04-13T17:21:28Z

1 revision

← Older revision		Revision as of 17:21, 13 April 2011
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>

Admin: 1 revision

2011-04-12T19:30:46Z

1 revision

← Older revision	Revision as of 19:30, 12 April 2011
(No difference)

JAL at 01:35, 12 April 2011

2011-04-12T01:35:30Z

New page

<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
[[Category:Recordset methods|RemoveRecord subroutine]]
<p>
<var>RemoveRecord</var> is a member of the <var>[[Recordset class|Recordset]]</var> class.
</p>

<var>RemoveRecord</var> removes the record in a <var>Record</var> object from the records
in an existing <var>Recordset</var> object.
It provides functionality identical to the
<var class="product">User Language</var> <var>Remove Record</var> statement, but it does so for <var>Recordset</var> objects.
==Syntax==
<p class="syntax">%target:RemoveRecord(recordObject)
</p>
===Syntax Terms===
<table class="syntaxTable">
<tr><th>%target</th>
<td>A non-null <var>Recordset</var> object variable.
</td></tr>
<tr><th>recordObject</th>
<td>A non-null <var>Record</var> object, which must have the same file context as <code>%target</code>.

</td></tr></table>
==Usage Notes==
<ul>
<li>Since <var>RemoveRecord</var> never adds a record to a <var>Recordset</var>, there are no lock
strength requirements for the method object or the input object.
<li>If the <var>Record</var> object argument of <var>RemoveRecord</var> is null, the request is cancelled.
</ul>
==Example==

In the following example, records not meeting
a certain criterion are removed from a <var>Recordset</var>:
<p class="code"> %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
</p>
With version 6.8 of <var class="product">Sirius Mods</var> and earlier, you must specify the
class name or an object variable before the <var>CurrentRecord</var> method name; for example:
<p class="code"> %mailList:removeRecord( -
%(Record in File customers):currentRecord)
</p>