Copy and DeepCopy (Record functions): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template: | {{Template:Record:DeepCopy subtitle}} | ||
<var>DeepCopy</var> is a function that returns an exact copy of the method <var>Record</var> object. It is identical to the <var>Record</var> <var>[[Copy (Record function)|Copy]]</var> method. <var>Record</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"]]). | <var>DeepCopy</var> is a function that returns an exact copy of the method <var>Record</var> object. It is identical to the <var>Record</var> <var>[[Copy (Record function)|Copy]]</var> method. <var>Record</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"]]). | ||
| Line 20: | Line 20: | ||
</td></tr></table> | </td></tr></table> | ||
==Usage | ==Usage notes== | ||
<ul> | <ul> | ||
<li>The main value of <var>DeepCopy</var> | <li>The main value of <var>DeepCopy</var> | ||
| Line 35: | Line 35: | ||
==See also== | ==See also== | ||
{{Template:Record:DeepCopy footer}} | {{Template:Record:DeepCopy footer}} | ||
Revision as of 21:50, 20 April 2011
Deep copy this Record object (Record class)
DeepCopy is a function that returns an exact copy of the method Record object. It is identical to the Record Copy method. Record objects are always copyable and "deep-copyable" (as these terms are described in "The Object class copy methods").
Syntax
%outRecord = record:DeepCopy[( [lockStrength], - [LoopLockStrength= lockStrength])]
Syntax terms
| %newRec | A Record object created by this method that contains a copy of the method object. |
|---|---|
| %rec | A Record object variable. The variable can be null, in which case the output object will also be null. |
| lockstrength | A value of the LockStrength enumeration that is the lock strength to give to the instantiated Record object. Options are: None, Share, or Exclusive, as described in "New (Recordset constructor)". This is an optional parameter, and it defaults to the lock strength of the method object. This parameter is only available in Sirius Mods 7.0 and later. |
| LoopLockStrength | The lock strength to be used for loops on the copied Record. This is an optional, name required, parameter, and it defaults to the LoopLockStrength of the method object Record. See "LoopLockStrength for Records". This parameter is available in Sirius Mods 7.0 and later. |
Usage notes
- The main value of DeepCopy of Record objects is to facilitate passing of these objects to and from daemons.
- The following example illustrates the use of the DeepCopy function:
%firstRec is object record in file geeks %currentRec is object record in file geeks ... %currentRec = %firstRec:deepcopy