LoadChangedRecords (XmlDoc subroutine): Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Automatically generated page update)
 
No edit summary
Line 1: Line 1:
{{Template:XmlDoc:LoadChangedRecords subtitle}}
{{Template:XmlDoc:LoadChangedRecords subtitle}}
This subroutine adds to an XmlDoc object a subtree that contains all record numbers that were changed within the current transaction.


This page is [[under construction]].
==Syntax==
==Syntax==
{{Template:XmlDoc:LoadChangedRecords syntax}}
{{Template:XmlDoc:LoadChangedRecords syntax}}
Line 9: Line 9:
<td>XmlDoc object</td></tr>
<td>XmlDoc object</td></tr>
<tr><th><var>Fields</var></th>
<tr><th><var>Fields</var></th>
<td><var>Boolean</var> value<br/>This default value of this argument is [[??]].</td></tr>
<td><var>Boolean</var> value<br/>
If TRUE is specified, the fields from the changed record will be included within the subtree.<br/>
This record extraction is the same operation that is performed by the NewFromRecord shared function and by the Record class ToXmlDoc function,
This default value of this argument is [[FALSE]].</td></tr>
</table>
</table>
==Usage notes==
==Usage notes==
==Examples==
==Examples==
As a simple example,
<p class="code">FRN %x
change bar to ("BAR" %x)         
end for                           
%doc = new                         
%doc:loadChangedRecords(Fields=true)
%doc:print</p>
The <var>XmlDoc</var> would have a structure similar to the following:
<p class="code"><ChangedRecords>                               
  <Record version="version#" file="file" number="%x">
  <field ...>
  ... first field from record %x
  </field>
  ...
  </Record>
</ChangedRecords></p>
==See also==
==See also==
{{Template:XmlDoc:LoadChangedRecords footer}}
{{Template:XmlDoc:LoadChangedRecords footer}}

Revision as of 14:05, 22 April 2022

Load ChangedRecords into this XmlDoc (XmlDoc class)

[Introduced in Model 204 7.8 βeta]

This subroutine adds to an XmlDoc object a subtree that contains all record numbers that were changed within the current transaction.

Syntax

doc:LoadChangedRecords[( [Fields= boolean])]

Syntax terms

doc XmlDoc object
Fields Boolean value

If TRUE is specified, the fields from the changed record will be included within the subtree.
This record extraction is the same operation that is performed by the NewFromRecord shared function and by the Record class ToXmlDoc function,

This default value of this argument is FALSE.

Usage notes

Examples

As a simple example,

FRN %x change bar to ("BAR" %x) end for %doc = new %doc:loadChangedRecords(Fields=true) %doc:print

The XmlDoc would have a structure similar to the following:

<ChangedRecords> <Record version="version#" file="file" number="%x"> <field ...> ... first field from record %x </field> ... </Record> </ChangedRecords>

See also