Copy (Recordset function) - Revision history

JAL: Redirected page to Copy and DeepCopy (Recordset functions)

2012-11-06T22:40:44Z

Redirected page to Copy and DeepCopy (Recordset functions)

← Older revision		Revision as of 22:40, 6 November 2012
Line 1:		Line 1:
	~~{{Template:Recordset:Copy subtitle}}~~		#REDIRECT [[Copy and DeepCopy (Recordset functions)]]

	~~<var>Copy</var> is a function that makes an exact copy of a <var>Recordset</var> object.~~
	~~It is identical to the <var>Recordset</var> <var>~~[[DeepCopy (Recordset function)\|DeepCopy]]</var> method. <var>Recordset</var> objects are always copyable and "deep-copyable" (as these terms are described in [[Copying objects#The Object class copy methods\|"The Object class copy methods"]]).

	~~==Syntax==~~
	~~{{Template:Recordset:Copy syntax}}~~
	~~===Syntax terms===~~
	~~<table class="syntaxTable">~~
	~~<tr><th>%newSet</th>~~
	~~<td>A <var>Recordset</var> object created by this method that contains a copy of the method object.~~
	~~</td></tr>~~
	~~<tr><th>%recSet</th>~~
	~~<td>A <var>Recordset</var> object variable. The variable can be null, in which case the output object will also be null.~~
	~~</td></tr>~~
	~~<tr><th>lockstrength</th>~~
	<td>A value of the <var>LockStrength</var> enumeration that is the lock strength to give to the instantiated <var>Recordset</var> object. Options are: <var>None</var>, <var>Share</var>, or <var>Exclusive</var>, as described in [[New (Recordset constructor)\|"New (Recordset constructor)"]]. This is an optional parameter, and it defaults to the lock strength of the method object. Specifying a stronger <var>LockStrength</var> than the method object's lock strength is invalid and results in request cancellation.
	~~</td></tr>~~
	~~<tr><th><var>LoopLockStrength</var></th>~~
	<td>The lock strength to be used for loops on the copied <var>Recordset</var>. This is an optional, [[Notation conventions for methods#Named parameters\|name required]], parameter, and it defaults to the <var>LoopLockStrength</var> of the method object <var>Recordset</var>. This parameter is available in <var class="product">Sirius Mods</var> 7.0 and later. See [[Recordset class#LoopLockStrength for Recordsets\|"LoopLockStrength for Recordsets"]].

	~~</td></tr></table>~~
	~~==Usage notes==~~
	~~<ul>~~
	~~<li>You can only create a copy of lock strength less than~~
	~~or equal to the original, so <var>Copy</var> needs to acquire no locks~~
	~~that the user does not already hold.~~
	~~Therefore, <var>Copy</var> cannot produce a record locking conflict.~~
	~~<li>Specifying a lock strength greater than the lock strength of the method~~
	~~object is a request-cancelling error.~~
	~~</ul>~~
	~~==Example==~~

	~~In the following example, a base record set is created, copied, then added to:~~
	~~<p class="code"> begin~~
	~~%baseStooges is object recordset in file glwproc~~
	~~%copyStooges is object recordset in file glwproc~~
	~~%curleyStooge is object recordset in file glwproc~~

	~~fd to %baseStooges name = 'MOE' or name = 'LARRY'~~
	~~end find~~
	~~text~~
	~~------~~
	~~The names of the %baseStooges are:~~
	~~end text~~
	~~fr in %baseStooges~~
	~~text~~
	~~{name}~~
	~~end text~~
	~~end for~~

	~~%copyStooges = %baseStooges:copy~~
	~~fd to %curleyStooge with name = 'CURLEY'~~
	~~end find~~
	~~%copyStooges:addRecordset( %curleyStooge )~~
	~~text~~
	~~------~~
	~~The names of the {%copyStooges:Count} %copyStooges are:~~
	~~end text~~
	~~fr in %copyStooges~~
	~~text~~
	~~{name}~~
	~~end text~~
	~~end for~~
	~~end~~
	~~</p>~~

	~~The example results follow:~~
	~~<p class="output"> ------~~
	~~The names of the %baseStooges are:~~
	~~MOE~~
	~~LARRY~~
	~~------~~
	~~The names of the 3 %copyStooges are:~~
	~~MOE~~
	~~LARRY~~
	~~CURLEY~~
	~~</p>~~
	~~==See also==~~
	~~{{Template:Recordset:Copy 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:Copy subtitle}}
	~~[[Category~~:Recordset ~~methods\|Copy function]]~~
	~~<p>~~
	~~<var>~~Copy~~</var> is a member of the <var>[[Recordset class\|Recordset]]</var> class.~~
	~~</p>~~

	<var>Copy</var> is a function that makes an exact copy of a <var>Recordset</var> object.		<var>Copy</var> is a function that makes an exact copy of a <var>Recordset</var> object.
Line 9:		Line 5:

	==Syntax==		==Syntax==
	~~<p class="syntax">%newSet = %recSet~~:Copy~~( [lockstrength] -~~		{{Template:Recordset:Copy syntax}}
	~~[,&nbsp;LoopLockStrength=lockstrength] )~~
	~~</p>~~
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
Line 83:		Line 77:
	CURLEY		CURLEY
	</p>		</p>
			==See also==
			{{Template:Recordset:Copy footer}}

JALWiccan: 1 revision

2011-04-13T17:21:30Z

1 revision

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

JAL2 at 17:21, 13 April 2011

2011-04-13T17:21:28Z

← Older revision		Revision as of 17:21, 13 April 2011
Line 10:		Line 10:
	==Syntax==		==Syntax==
	<p class="syntax">%newSet = %recSet:Copy( [lockstrength] -		<p class="syntax">%newSet = %recSet:Copy( [lockstrength] -
	[, LoopLockStrength=lockstrength] )		[,&nbsp;LoopLockStrength=lockstrength] )
	</p>		</p>
	===Syntax ~~Terms~~===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%newSet</th>		<tr><th>%newSet</th>

JAL2 at 23:20, 12 April 2011

2011-04-12T23:20:29Z

← Older revision		Revision as of 23:20, 12 April 2011
Line 5:		Line 5:
	</p>		</p>

	<var>Copy</var> is a function that makes a copy of a <var>Recordset</var> object.		<var>Copy</var> is a function that makes an exact copy of a <var>Recordset</var> object.
			It is identical to the <var>Recordset</var> <var>[[DeepCopy (Recordset function)\|DeepCopy]]</var> method. <var>Recordset</var> objects are always copyable and "deep-copyable" (as these terms are described in [[Copying objects#The Object class copy methods\|"The Object class copy methods"]]).
	~~The~~ <var>[[DeepCopy (Recordset function)\|DeepCopy]]</var> ~~function is identical to <var>Copy</var>, but it flags the~~ <var>Recordset</var> ~~class as~~ "deep-copyable"
	(as described in [[Copying objects#The Object class copy methods\|"The Object class copy methods"]]).

	==Syntax==		==Syntax==

JAL2 at 21:22, 12 April 2011

2011-04-12T21:22:35Z

← Older revision		Revision as of 21:22, 12 April 2011
Line 6:		Line 6:

	<var>Copy</var> is a function that makes a copy of a <var>Recordset</var> object.		<var>Copy</var> is a function that makes a copy of a <var>Recordset</var> object.

			The <var>[[DeepCopy (Recordset function)\|DeepCopy]]</var> function is identical to <var>Copy</var>, but it flags the <var>Recordset</var> class as "deep-copyable"
			(as described in [[Copying objects#The Object class copy methods\|"The Object class copy methods"]]).

	==Syntax==		==Syntax==
Line 26:		Line 29:

	</td></tr></table>		</td></tr></table>
	==Usage ~~Notes~~==		==Usage notes==
	<ul>		<ul>
	<li>You can only create a copy of lock strength less than		<li>You can only create a copy of lock strength less than

JAL2 at 21:12, 12 April 2011

2011-04-12T21:12:12Z

← Older revision		Revision as of 21:12, 12 April 2011
Line 1:		Line 1:
	<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>		<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
	[[Category:Recordset methods\|Copy ~~and DeepCopy functions~~]]		[[Category:Recordset methods\|Copy function]]
	<p>		<p>
	<var>Copy</var> ~~and <var>DeepCopy</var> are members~~ of the <var>[[Recordset class\|Recordset]]</var> class.		<var>Copy</var> is a member of the <var>[[Recordset class\|Recordset]]</var> class.
	</p>		</p>

	<var>Copy</var> is a function that makes a copy of a <var>Recordset</var> object.		<var>Copy</var> is a function that makes a copy of a <var>Recordset</var> object.
	~~<var>DeepCopy</var> is a version 6.8 function that performs the identical function~~
	~~as <var>Copy</var>, but flags the <var>Recordset</var> class as "deep-copyable"~~
	~~(as described in [[Copying objects#The Object class copy methods\|"The Object class copy methods"]]).~~
	==Syntax==		==Syntax==
	<p class="syntax">%newSet = %recSet:Copy( [lockstrength] -		<p class="syntax">%newSet = %recSet:Copy( [lockstrength] -
	[, LoopLockStrength=lockstrength] )		[, LoopLockStrength=lockstrength] )

	~~%newSet = %recSet:DeepCopy([lockstrength] -~~
	~~[, LoopLockStrength=lockstrength] )~~
	</p>		</p>
	===Syntax Terms===		===Syntax Terms===
Line 27:		Line 22:
	<td>A value of the <var>LockStrength</var> enumeration that is the lock strength to give to the instantiated <var>Recordset</var> object. Options are: <var>None</var>, <var>Share</var>, or <var>Exclusive</var>, as described in [[New (Recordset constructor)\|"New (Recordset constructor)"]]. This is an optional parameter, and it defaults to the lock strength of the method object. Specifying a stronger <var>LockStrength</var> than the method object's lock strength is invalid and results in request cancellation.		<td>A value of the <var>LockStrength</var> enumeration that is the lock strength to give to the instantiated <var>Recordset</var> object. Options are: <var>None</var>, <var>Share</var>, or <var>Exclusive</var>, as described in [[New (Recordset constructor)\|"New (Recordset constructor)"]]. This is an optional parameter, and it defaults to the lock strength of the method object. Specifying a stronger <var>LockStrength</var> than the method object's lock strength is invalid and results in request cancellation.
	</td></tr>		</td></tr>
	<tr><th><b>LoopLockStrength=</b>~~lockstrength~~</th>		<tr><th><var>LoopLockStrength</var></th>
	<td>The lock strength to be used for loops on the copied <var>Recordset</var>. This is an optional, name required, parameter, and it defaults to the <var>LoopLockStrength</var> of the method object <var>Recordset</var>. This parameter is ~~only~~ available in <var class="product">Sirius Mods</var> 7.0 and later. See [[Recordset class#LoopLockStrength for Recordsets\|"LoopLockStrength for Recordsets"]].		<td>The lock strength to be used for loops on the copied <var>Recordset</var>. This is an optional, [[Notation conventions for methods#Named parameters\|name required]], parameter, and it defaults to the <var>LoopLockStrength</var> of the method object <var>Recordset</var>. This parameter is available in <var class="product">Sirius Mods</var> 7.0 and later. See [[Recordset class#LoopLockStrength for Recordsets\|"LoopLockStrength for Recordsets"]].

	</td></tr></table>		</td></tr></table>

Tom: Created page with "
Copy and DeepCopy functions
`Copy` and `DeepCop..."`

2011-04-12T19:42:54Z

Created page with "<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span> Copy and DeepCopy functions <p> <var>Copy</var> and <var>DeepCop..."

New page

<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
[[Category:Recordset methods|Copy and DeepCopy functions]]
<p>
<var>Copy</var> and <var>DeepCopy</var> are members of the <var>[[Recordset class|Recordset]]</var> class.
</p>

<var>Copy</var> is a function that makes a copy of a <var>Recordset</var> object.
<var>DeepCopy</var> is a version 6.8 function that performs the identical function
as <var>Copy</var>, but flags the <var>Recordset</var> class as "deep-copyable"
(as described in [[Copying objects#The Object class copy methods|"The Object class copy methods"]]).
==Syntax==
<p class="syntax">%newSet = %recSet:Copy( [lockstrength] -
[, LoopLockStrength=lockstrength] )

%newSet = %recSet:DeepCopy([lockstrength] -
[, LoopLockStrength=lockstrength] )
</p>
===Syntax Terms===
<table class="syntaxTable">
<tr><th>%newSet</th>
<td>A <var>Recordset</var> object created by this method that contains a copy of the method object.
</td></tr>
<tr><th>%recSet</th>
<td>A <var>Recordset</var> object variable. The variable can be null, in which case the output object will also be null.
</td></tr>
<tr><th>lockstrength</th>
<td>A value of the <var>LockStrength</var> enumeration that is the lock strength to give to the instantiated <var>Recordset</var> object. Options are: <var>None</var>, <var>Share</var>, or <var>Exclusive</var>, as described in [[New (Recordset constructor)|"New (Recordset constructor)"]]. This is an optional parameter, and it defaults to the lock strength of the method object. Specifying a stronger <var>LockStrength</var> than the method object's lock strength is invalid and results in request cancellation.
</td></tr>
<tr><th><b>LoopLockStrength=</b>lockstrength</th>
<td>The lock strength to be used for loops on the copied <var>Recordset</var>. This is an optional, name required, parameter, and it defaults to the <var>LoopLockStrength</var> of the method object <var>Recordset</var>. This parameter is only available in <var class="product">Sirius Mods</var> 7.0 and later. See [[Recordset class#LoopLockStrength for Recordsets|"LoopLockStrength for Recordsets"]].

</td></tr></table>
==Usage Notes==
<ul>
<li>You can only create a copy of lock strength less than
or equal to the original, so <var>Copy</var> needs to acquire no locks
that the user does not already hold.
Therefore, <var>Copy</var> cannot produce a record locking conflict.
<li>Specifying a lock strength greater than the lock strength of the method
object is a request-cancelling error.
</ul>
==Example==

In the following example, a base record set is created, copied, then added to:
<p class="code"> begin
%baseStooges is object recordset in file glwproc
%copyStooges is object recordset in file glwproc
%curleyStooge is object recordset in file glwproc

fd to %baseStooges name = 'MOE' or name = 'LARRY'
end find
text
------
The names of the %baseStooges are:
end text
fr in %baseStooges
text
{name}
end text
end for

%copyStooges = %baseStooges:copy
fd to %curleyStooge with name = 'CURLEY'
end find
%copyStooges:addRecordset( %curleyStooge )
text
------
The names of the {%copyStooges:Count} %copyStooges are:
end text
fr in %copyStooges
text
{name}
end text
end for
end
</p>

The example results follow:
<p class="output"> ------
The names of the %baseStooges are:
MOE
LARRY
------
The names of the 3 %copyStooges are:
MOE
LARRY
CURLEY
</p>

Copy (Recordset function) - Revision history

JAL: Redirected page to Copy and DeepCopy (Recordset functions)

DmeWiccan: 1 revision

JALWiccan: 1 revision

JALWiccan: 1 revision

JAL2 at 17:21, 13 April 2011

JAL2 at 23:20, 12 April 2011

JAL2 at 21:22, 12 April 2011

JAL2 at 21:12, 12 April 2011

Tom: Created page with " Copy and DeepCopy functions Copy and DeepCop..."

Tom: Created page with "
Copy and DeepCopy functions
`Copy` and `DeepCop..."`