Record methods syntax: Difference between revisions
Jump to navigation
Jump to search
m (Automatically generated page update) |
(Automatically generated page update) |
||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
replaced, so any manual edits will be lost. You've been warned. --> | replaced, so any manual edits will be lost. You've been warned. --> | ||
{{Template:Syntax list header|class=Record}} | {{Template:Syntax list header|class=Record}} | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top:1px solid;"><span class="term">%outRecord</span><span class="literal"> =</span> <span class="term">record</span><span class="literal">:[[Copy (Record function)|Copy]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="LockStrength">lockStrength</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="LockStrength">LoopLockStrength=</span> <span class="term" title="LockStrength">lockStrength</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top:1px solid;"><span class="term">%outRecord</span><span class="literal"> =</span> <span class="term">record</span><span class="literal">:[[Copy (Record function)|Copy]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="LockStrength">lockStrength</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="LockStrength">LoopLockStrength=</span> <span class="term" title="LockStrength">lockStrength</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%record</span><span class="literal"> =</span> <span class="squareb">[</span><span class="literal">%(Record In </span><span class="term">filOrGrp name</span><span class="literal">)</span><span class="squareb">]</span><span class="literal"> | |||
<span class="squareb">[</span><span class="literal" title="LockStrength">LoopLockStrength=</span> <span class="term" title="LockStrength">lockStrength</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | Throws [[RecordLockingConflict class|RecordLockingConflict]]</p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%string</span><span class="literal"> =</span> <span class="literal">%(Record In </span><span class="term">filOrGrp name</span><span class="literal">):[[CurrentImagineFile (Record function)|CurrentImagineFile]]</span></p> | |||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%record</span><span class="literal"> =</span> <span class="squareb">[</span><span class="literal">%(Record In </span><span class="term">filOrGrp name</span><span class="literal">):</span><span class="squareb">]</span><span class="literal">[[CurrentRecord (Record function)|CurrentRecord]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="LockStrength">lockStrength</span><span class="squareb">]</span><span class="comma">,</span> - | |||
<span class="squareb">[</span><span class="literal" title="LockStrength">LoopLockStrength=</span> <span class="term" title="LockStrength">lockStrength</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span> | |||
Throws [[RecordLockingConflict class|RecordLockingConflict]]</p> | |||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%string</span><span class="literal"> =</span> <span class="literal">%(Record In </span><span class="term">filOrGrp name</span><span class="literal">):[[CurrentRecordId (Record function)|CurrentRecordId]]</span></p> | |||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%outRecord</span><span class="literal"> =</span> <span class="term">record</span><span class="literal">:[[DeepCopy (Record function)|DeepCopy]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="LockStrength">lockStrength</span><span class="squareb">]</span><span class="comma">,</span> - | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%outRecord</span><span class="literal"> =</span> <span class="term">record</span><span class="literal">:[[DeepCopy (Record function)|DeepCopy]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="LockStrength">lockStrength</span><span class="squareb">]</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="literal" title="LockStrength">LoopLockStrength=</span> <span class="term" title="LockStrength">lockStrength</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | <span class="squareb">[</span><span class="literal" title="LockStrength">LoopLockStrength=</span> <span class="term" title="LockStrength">lockStrength</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%string</span><span class="literal"> =</span> <span class="term">record</span><span class="literal">:[[FileName (Record function)|FileName]]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%string</span><span class="literal"> =</span> <span class="term">record</span><span class="literal">:[[FileName (Record function)|FileName]]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%string</span><span class="literal"> =</span> <span class="term">record</span><span class="literal">:[[ImagineFile (Record function)|ImagineFile]]</span></p> | |||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%boolean</span><span class="literal"> =</span> <span class="term">record</span><span class="literal">:[[IsUpdated (Record function)|IsUpdated]]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%boolean</span><span class="literal"> =</span> <span class="term">record</span><span class="literal">:[[IsUpdated (Record function)|IsUpdated]]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%lockStrength</span><span class="literal"> =</span> <span class="term">record</span><span class="literal">:[[LockStrength (Record function)|LockStrength]]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%lockStrength</span><span class="literal"> =</span> <span class="term">record</span><span class="literal">:[[LockStrength (Record function)|LockStrength]]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%currentLockStrength</span><span class="literal"> =</span> <span class="term">record</span><span class="literal">:[[LoopLockStrength (Record property)|LoopLockStrength]]</span> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%currentLockStrength</span><span class="literal"> =</span> <span class="term">record</span><span class="literal">:[[LoopLockStrength (Record property)|LoopLockStrength]]</span> | ||
<span class="term">record</span><span class="literal">:[[LoopLockStrength (Record property)|LoopLockStrength]]</span> <span class="literal">= </span><span class="term">newLockStrength</span></p> | <span class="term">record</span><span class="literal">:[[LoopLockStrength (Record property)|LoopLockStrength]]</span> <span class="literal">= </span><span class="term">newLockStrength</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%fileRecord</span><span class="literal"> =</span> <span class="squareb">[</span><span class="literal">%(Record In </span><span class="term">filOrGrp name</span><span class="literal">)</span><span class="squareb">]</span><span class="literal"> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%fileRecord</span><span class="literal"> =</span> <span class="squareb">[</span><span class="literal">%(Record In </span><span class="term">filOrGrp name</span><span class="literal">):</span><span class="squareb">]</span><span class="literal">[[New (Record constructor)|New]]</span><span class="literal">(</span> <span class="term" title="Number">number</span><span class="comma">,</span> <span class="squareb">[</span><span class="term" title="LockStrength">lockStrength</span><span class="squareb">]</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="literal" title="LockStrength">LoopLockStrength=</span> <span class="term" title="LockStrength">lockStrength</span><span class="squareb">]</span><span class="literal">)</span></p> | <span class="squareb">[</span><span class="literal" title="LockStrength">LoopLockStrength=</span> <span class="term" title="LockStrength">lockStrength</span><span class="squareb">]</span><span class="literal">)</span> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%groupRecord</span><span class="literal"> =</span> <span class="squareb">[</span><span class="literal">%(Record In </span><span class="term">filOrGrp name</span><span class="literal">)</span><span class="squareb">]</span><span class="literal"> | |||
Throws [[RecordLockingConflict class|RecordLockingConflict]]</p> | |||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%groupRecord</span><span class="literal"> =</span> <span class="squareb">[</span><span class="literal">%(Record In </span><span class="term">filOrGrp name</span><span class="literal">):</span><span class="squareb">]</span><span class="literal">[[New (Record constructor)|New]]</span><span class="literal">(</span> <span class="term" title="Number">number</span><span class="comma">,</span> <span class="term" title="String">string</span><span class="comma">,</span> - | |||
<span class="squareb">[</span><span class="term" title="LockStrength">lockStrength</span><span class="squareb">]</span><span class="comma">,</span> - | <span class="squareb">[</span><span class="term" title="LockStrength">lockStrength</span><span class="squareb">]</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="literal" title="LockStrength">LoopLockStrength=</span> <span class="term" title="LockStrength">lockStrength</span><span class="squareb">]</span><span class="literal">)</span></p> | <span class="squareb">[</span><span class="literal" title="LockStrength">LoopLockStrength=</span> <span class="term" title="LockStrength">lockStrength</span><span class="squareb">]</span><span class="literal">)</span> | ||
Throws [[RecordLockingConflict class|RecordLockingConflict]]</p> | |||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%fileRecord</span><span class="literal"> =</span> <span class="squareb">[</span><span class="literal">%(Record In </span><span class="term">filOrGrp name</span><span class="literal">):</span><span class="squareb">]</span><span class="literal">[[NewFromRecordId (Record function)|NewFromRecordId]]</span><span class="literal">(</span> <span class="term" title="String">recordId</span><span class="literal">)</span></p> | |||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%groupRecord</span><span class="literal"> =</span> <span class="squareb">[</span><span class="literal">%(Record In </span><span class="term">filOrGrp name</span><span class="literal">):</span><span class="squareb">]</span><span class="literal">[[NewFromRecordId (Record function)|NewFromRecordId]]</span><span class="literal">(</span> <span class="term" title="String">recordId</span><span class="comma">,</span> <span class="term" title="String">filename</span><span class="literal">)</span></p> | |||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">record</span><span class="literal">:[[PAI (Record subroutine)|PAI]]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">record</span><span class="literal">:[[PAI (Record subroutine)|PAI]]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">record</span><span class="literal">:[[PrintAllInformation (Record subroutine)|PrintAllInformation]]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">record</span><span class="literal">:[[PrintAllInformation (Record subroutine)|PrintAllInformation]]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%string</span><span class="literal"> =</span> <span class="term">record</span><span class="literal">:[[RecordId (Record function)|RecordId]]</span></p> | |||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%number</span><span class="literal"> =</span> <span class="term">record</span><span class="literal">:[[RecordNumber (Record function)|RecordNumber]]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%number</span><span class="literal"> =</span> <span class="term">record</span><span class="literal">:[[RecordNumber (Record function)|RecordNumber]]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%string</span><span class="literal"> =</span> <span class="term">record</span><span class="literal">:[[ToString (Record function)|ToString]]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%string</span><span class="literal"> =</span> <span class="term">record</span><span class="literal">:[[ToString (Record function)|ToString]]</span></p> | ||
| Line 24: | Line 38: | ||
<span class="squareb">[</span><span class="literal" title="Boolean">AttributeNames=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">NamesToLower=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> - | <span class="squareb">[</span><span class="literal" title="Boolean">AttributeNames=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">NamesToLower=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="literal" title="Boolean">AllowUnreversible=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> - | <span class="squareb">[</span><span class="literal" title="Boolean">AllowUnreversible=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="literal" title="Boolean">CodepageTable=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">AllowNull=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | <span class="squareb">[</span><span class="literal" title="Boolean">CodepageTable=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">Base64Encode=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="literal" title="CharacterToUnicodeMap">CharacterMap=</span> <span class="term" title="CharacterToUnicodeMap">characterToUnicodeMap</span><span class="squareb">]</span><span class="comma">,</span> - | |||
<span class="squareb">[</span><span class="literal" title="Boolean">AllowNull=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span> | |||
Throws [[CharacterTranslationException class|CharacterTranslationException]]</p> | |||
Latest revision as of 21:18, 28 March 2025
The syntax for each of the Record class methods is shown below.
Square brackets indicate optional elements of the method invocation. See also the notation conventions for methods and the List of Record methods.
%outRecord = record:Copy[( [lockStrength], [LoopLockStrength= lockStrength])] Throws RecordLockingConflict
%string = %(Record In filOrGrp name):CurrentImagineFile
%record = [%(Record In filOrGrp name):]CurrentRecord[( [lockStrength], - [LoopLockStrength= lockStrength])] Throws RecordLockingConflict
%string = %(Record In filOrGrp name):CurrentRecordId
%outRecord = record:DeepCopy[( [lockStrength], - [LoopLockStrength= lockStrength])]
%string = record:FileName
%string = record:ImagineFile
%boolean = record:IsUpdated
%lockStrength = record:LockStrength
%currentLockStrength = record:LoopLockStrength record:LoopLockStrength = newLockStrength
%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
%fileRecord = [%(Record In filOrGrp name):]NewFromRecordId( recordId)
%groupRecord = [%(Record In filOrGrp name):]NewFromRecordId( recordId, filename)
record:PAI
record:PrintAllInformation
%string = record:RecordId
%number = record:RecordNumber
%string = record:ToString
%doc = record:ToXmlDoc[( [AttributeValues= boolean], - [AttributeNames= boolean], [NamesToLower= boolean], - [AllowUnreversible= boolean], - [CodepageTable= boolean], [Base64Encode= boolean], - [CharacterMap= characterToUnicodeMap], - [AllowNull= boolean])] Throws CharacterTranslationException