RecordIsUpdated (System function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (guess subtitle, syntax and footer template names, match syntax terms to template, lots of tags and edits.) |
||
Line 1: | Line 1: | ||
{{Template:System:RecordIsUpdated subtitle}} | |||
The <var>RecordIsUpdated</var> shared function returns a <var>Boolean</var> value that indicates whether a record you specify (by file name and record number) has been updated in the current transaction. | |||
==Syntax== | |||
< | {{Template:System:RecordIsUpdated syntax}} | ||
RecordIsUpdated | ===Syntax Terms=== | ||
</ | <table class="syntaxTable"> | ||
<tr><th>%boolean</th><td>The Boolean enumeration value indicating whether the record has been updated. For more information about these enumerations, see [["Using Boolean enumerations"]]. </td></tr> | |||
<tr><th>%(System)</th><td>The class name in parentheses denotes a shared method.</td></tr> | |||
indicates whether a record you specify (by file name and record number) | <tr><th>filename</th><td>A string that is the name of the file that contains the record whose update status you are querying.</td></tr> | ||
has been updated in the current transaction. | <tr><th>recnum</th><td>The number of the record whose update status you are querying.</td></tr> | ||
</table> | |||
==Usage Notes== | |||
<ul><li><var>RecordIsUpdated</var> is available in <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> Version 7.7 and later. | |||
< | |||
< | |||
< | |||
has been updated. | |||
For more information about these enumerations, see [[Using Boolean enumerations]]. | |||
< | |||
< | |||
< | |||
< | |||
update status you are querying. | |||
< | |||
< | |||
</ | |||
<ul> | |||
<li>[[ | |||
</ul> | </ul> | ||
== | |||
==Examples== | |||
The following request fragment sketches a record loop that reports to | <ol><li>The following request fragment sketches a record loop that reports to the audit trail if this will be the initial update in the transaction for the records that satisfy a particular condition: | ||
the audit trail if this will be the initial update in the transaction for the | |||
records that satisfy a particular condition: | |||
<p class="code"><nowiki>%recs is object recordset in file myfile | <p class="code"><nowiki>%recs is object recordset in file myfile | ||
%rec is object record in file myfile | %rec is object record in file myfile | ||
Line 46: | Line 25: | ||
for each record in %recs | for each record in %recs | ||
... | ... | ||
* if some condition is satisfied | |||
%rec = CurrentRecord | %rec = CurrentRecord | ||
if %(system):RecordIsUpdated($curfile, $currec) ne true then | if %(system):RecordIsUpdated($curfile, $currec) ne true then | ||
Line 51: | Line 31: | ||
end if | end if | ||
... | ... | ||
* perform record update | |||
end if | end if | ||
end for | end for | ||
</nowiki></p> | </nowiki></p></ol> | ||
==See also== | |||
<ul> | |||
<li>[[CurrentRecordIsUpdated (System function)|CurrentRecordIsUpdated]] reports whether the currently selected record has been updated within the current transaction. | |||
</ul> | |||
{{Template:System:RecordIsUpdated footer}} |
Revision as of 11:00, 24 March 2011
Is the indicated record updated? (System class)
[Introduced in Sirius Mods 7.7]
The RecordIsUpdated shared function returns a Boolean value that indicates whether a record you specify (by file name and record number) has been updated in the current transaction.
Syntax
%boolean = %(System):RecordIsUpdated( string, number)
Syntax Terms
%boolean | The Boolean enumeration value indicating whether the record has been updated. For more information about these enumerations, see "Using Boolean enumerations". |
---|---|
%(System) | The class name in parentheses denotes a shared method. |
filename | A string that is the name of the file that contains the record whose update status you are querying. |
recnum | The number of the record whose update status you are querying. |
Usage Notes
- RecordIsUpdated is available in "Sirius Mods" Version 7.7 and later.
Examples
- The following request fragment sketches a record loop that reports to the audit trail if this will be the initial update in the transaction for the records that satisfy a particular condition:
%recs is object recordset in file myfile %rec is object record in file myfile fd to %recs end find for each record in %recs ... * if some condition is satisfied %rec = CurrentRecord if %(system):RecordIsUpdated($curfile, $currec) ne true then Audit 'First update of Record num: ' %rec:RecordNumber end if ... * perform record update end if end for
See also
- CurrentRecordIsUpdated reports whether the currently selected record has been updated within the current transaction.