RecordIsUpdated (System function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
(Automatically generated page update)
 
(20 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<span style="font-size:120%; color:black"><b><section begin=dpl_desc/>Has specified record been updated?<section end=dpl_desc/></b></span>
{{Template:System:RecordIsUpdated subtitle}}
[[Category:System methods|RecordIsUpdated function]]
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.  
[[Category:System/Subsystem methods]]
<!--DPL?? Category:System methods|RecordIsUpdated function: Has specified record been updated?-->
<p>
RecordIsUpdated is a member of the [[System class]].
</p>


This shared function returns a Boolean value that
==Syntax==
indicates whether a record you specify (by file name and record number)
{{Template:System:RecordIsUpdated syntax}}
has been updated in the current transaction.


The RecordIsUpdated method is available in ''Sirius Mods'' 7.7 and later.
===Syntax terms===
===Syntax===
<table class="syntaxTable">
  %bool = %(system):RecordIsUpdated(filename, recnum)
<tr><th>%boolean</th>
====Syntax Terms====
<td>The <var>[[Boolean enumeration]]</var> value indicating whether the record has been updated. </td></tr>
<dl>
<dt><i><b>%bool</b></i>
<dd>The Boolean enumeration value indicating whether the record
has been updated.
For more information about these enumerations, see [[Using Boolean enumerations]].
<dt>%(system)
<dd>The class name in parentheses denotes a shared method.
<dt>filename
<dd>A string that is the name of the file that contains the record whose
update status you are querying.
<dt>recnum
<dd>The number of the record whose update status you are querying.


</dl>
<tr><th><var class="nobr">%(System)</var></th>
===Usage Notes===
<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|shared]] method.</td></tr>
<ul>
 
<li>[[CurrentRecordIsUpdated (System function)|CurrentRecordIsUpdated]] reports whether the currently
<tr><th>string</th>
selected record has been updated within the current transaction.
<td>A string that is the name of the file that contains the record whose update status you are querying.</td></tr>
 
<tr><th>number</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.
</ul>
</ul>
===Example===


The following request fragment sketches a record loop that reports to
==Examples==
the audit trail if this will be the initial update in the transaction for the
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:
records that satisfy a particular condition:
<p class="code"><nowiki>%recs is object recordset in file myfile
<pre style="xmp">
%rec is object record in file myfile
    %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
</nowiki></p>


    fd to %recs
==See also==
    end find
<ul>
    for each record in %recs
<li><var>[[CurrentRecordIsUpdated (System function)|CurrentRecordIsUpdated]]</var> reports whether the currently selected record has been updated within the current transaction.
      ...
 
      %rec = CurrentRecord
<li><var>[[IsUpdated (Record function)|IsUpdated]]</var> reports whether a record referenced by a <var>[[Record class|Record]]</var> object has been updated within the current transaction.
        if %(system):RecordIsUpdated($curfile, $currec) ne true then
</ul>
          Audit 'First update of Record num: ' %rec:RecordNumber
{{Template:System:RecordIsUpdated footer}}
        end if
      ...
      end if
    end for
</pre>

Latest revision as of 00:26, 16 February 2014

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.
%(System) The class name in parentheses denotes a shared method.
string A string that is the name of the file that contains the record whose update status you are querying.
number 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.
  • IsUpdated reports whether a record referenced by a Record object has been updated within the current transaction.
Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=RecordIsUpdated_(System_function)&oldid=67463"