CurrentRecord (Record function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
{{Template:Record:CurrentRecord subtitle}}
[[Category:Record methods|CurrentRecord function]]
<p>
<var>CurrentRecord</var> is a member of the <var>[[Record class|Record]]</var> class.
</p>


This shared function instantiates a <var>Record</var> object
This shared function instantiates a <var>Record</var> object
from the current record in a <var>For</var> loop or record set.
from the current record in a <var>For</var> loop or record set.
==Syntax==
==Syntax==
<p class="syntax">%rec = [%(Record):]CurrentRecord( [lockstr]            -
{{Template:Record:CurrentRecord syntax}}
                    [,&nbsp;LoopLockStrength=lockstrength] )
===Syntax terms===
</p>
===Syntax Terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%(Record)</th>
<tr><th>%(Record)</th>
Line 25: Line 19:


</td></tr></table>
</td></tr></table>
==Usage Notes==
==Usage notes==
<ul>
<ul>
<li><var>CurrentRecord</var> must be invoked from inside a record loop
<li><var>CurrentRecord</var> must be invoked from inside a record loop
Line 35: Line 29:
[[Record class#Using CurrentRecord to instantiate a Record object|"Using CurrentRecord to instantiate a Record object]].
[[Record class#Using CurrentRecord to instantiate a Record object|"Using CurrentRecord to instantiate a Record object]].
</ul>
</ul>
==See also==
{{Template:Record:CurrentRecord footer}}

Revision as of 21:50, 20 April 2011

Create a Record object from current record in For loop or Recordset (Record class)


This shared function instantiates a Record object from the current record in a For loop or record set.

Syntax

%record = [%(Record In filOrGrp name):]CurrentRecord[( [lockStrength], - [LoopLockStrength= lockStrength])] Throws RecordLockingConflict

Syntax terms

%(Record) Since this is a shared method, this method object can be the class name, Record, in parentheses, or it can be a declared Record object variable, which must have the same file or group context as the For loop within which CurrentRecord is invoked.

Under Sirius Mods version 6.8 and later, the CurrentRecord method does not have to be preceded by any method object, since it acts like a constructor. For more information about shared methods, see "Shared class members".

lockstr The value of a Lockstrength enumeration: None, Share, or Exclusive. These correspond to standard Model 204 record-locking levels, as described below. The default lock strength of the new Record object is Share.
None
Record is not locked.
No locks are held on the object, so there is no conflict with others holding Share or Exclusive locks (readers and updaters may proceed).
Share
Record is share locked.
This level allows other users to hold a Share lock, but not an Exclusive lock (allows readers but not updaters to proceed).
Exclusive
Record is exclusively locked.
This level prohibits others from holding either an Exclusive lock or a Share lock. It is generally used for update.
LoopLockStrength=lockstrength The lock strength to be used for loops on the Record. This is an optional, name required, parameter, and it defaults to None. See "LoopLockStrength for Records". This parameter is available in Sirius Mods 7.0 and later.

Usage notes

  • CurrentRecord must be invoked from inside a record loop that has the same file or group context as declared for the Record object variable.
  • Under Sirius Mods version 6.8 and later, the CurrentRecord method name does not have to be preceded by the class name or by an object variable.
  • For more information and examples, see "Using CurrentRecord to instantiate a Record object.

See also

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=CurrentRecord_(Record_function)&oldid=44273"