New (Record constructor): Difference between revisions
mNo edit summary |
mNo edit summary |
||
Line 1: | Line 1: | ||
{{Template:Record:New subtitle}} | {{Template:Record:New subtitle}} | ||
This shared function has one required parameter if in file context, two required parameters if in group context, and two optional parameters in either context. The parameters are applied by the <var>New</var> constructor to the newly instantiated object. | |||
This shared function | |||
==Syntax== | ==Syntax== | ||
{{Template:Record:file:New syntax}} | {{Template:Record:file:New syntax}} |
Revision as of 00:30, 27 April 2011
Create a new Record object (Record class)
This shared function has one required parameter if in file context, two required parameters if in group context, and two optional parameters in either context. The parameters are applied by the New constructor to the newly instantiated object.
Syntax
%fileRecord = [%(Record In filOrGrp name):]New( number, [lockStrength], - [LoopLockStrength= lockStrength]) Throws RecordLockingConflict
%groupRecord = [%(Record In filOrGrp name):]New( number, string, - [lockStrength], - [LoopLockStrength= lockStrength]) Throws RecordLockingConflict
Syntax terms
%groupRecord | A declared Record object variable in group context. |
---|---|
number | The number of the record to which the instantiated Record object will refer. |
string | For group context, the name of the file that contains the record that the instantiated Record object will reference. |
lockstrength | 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, matching the locking behavior of a User Language For Record Number statement.
|
LoopLockStrength | The lock strength to be used for For Record loops on the Record object. This is an optional, name required, parameter, and it defaults to None. See "LoopLockStrength for Records". This parameter is available under Sirius Mods 7.0 and later. |
Usage notes
- New is a constructor and as such can be called with no object, with an
explicit class name, or with an object variable, even if that object is null:
%rec = new(share) %rec = %(Record):new(exclusive) %rec = %rec:new(none)
- The LockStrength returns the locking level of a Record object.
- For more information about constructors, see "Creating object instances"
- For more information about using New, see "Using New to instantiate a Record object".