Difference between revisions of "XMLFIRST()"
From Lianjapedia
Helen.george (Talk | contribs) |
Helen.george (Talk | contribs) |
||
| Line 11: | Line 11: | ||
The XMLFIRST() function will read the first record contained in the specified XML file, returning the number of fields in the record. | The XMLFIRST() function will read the first record contained in the specified XML file, returning the number of fields in the record. | ||
| − | {| class="wikitable" width=100% | + | {| class="wikitable" width="100%" |
| − | !width=25%|Parameters||Required||Default||Description | + | !width="25%"|Parameters||Required||Default||Description |
|- | |- | ||
| − | |<XML filename>||valign=top|Yes||valign=top|None||The name of the XML file to read. | + | |<XML filename>||valign="top"|Yes||valign="top"|None||The name of the XML file to read. |
|- | |- | ||
| − | |valign=top|<memvar1>||valign=top|Yes||valign=top|None||The name of a memory variable that will return the XML target table name. Ignored if XMLFORMAT is ADO. | + | |valign="top"|<memvar1>||valign="top"|Yes||valign="top"|None||The name of a memory variable that will return the XML target table name. Ignored if XMLFORMAT is ADO. |
|- | |- | ||
| − | |valign=top|<memvar2>||valign=top|Yes||valign=top|None||The name of a memory variable that will return the transaction type for the record. Valid types are INSERT, UPDATE and DELETE. Ignored if XMLFORMAT is ADO. | + | |valign="top"|<memvar2>||valign="top"|Yes||valign="top"|None||The name of a memory variable that will return the transaction type for the record. Valid types are INSERT, UPDATE and DELETE. Ignored if XMLFORMAT is ADO. |
|- | |- | ||
| − | |valign=top|<memvar3>||valign=top|Yes||valign=top|None||The name of a memory variable that will return the where condition for the transaction if it is an UPDATE or DELETE type. Ignored if XMLFORMAT is ADO. | + | |valign="top"|<memvar3>||valign="top"|Yes||valign="top"|None||The name of a memory variable that will return the where condition for the transaction if it is an UPDATE or DELETE type. Ignored if XMLFORMAT is ADO. |
|- | |- | ||
| − | valign=top|<array1>||valign=top|Yes||valign=top|None||The name of an array that will be created automatically and loaded with the field names for the record. | + | |valign="top"|<array1>||valign="top"|Yes||valign="top"|None||The name of an array that will be created automatically and loaded with the field names for the record. |
|- | |- | ||
| − | valign=top | + | |valign="top"|<array2>||valign="top"|Yes||valign="top"|None||The name of an array that will be created created automatically and loaded with the data for each field in the record. |
|- | |- | ||
|} | |} | ||
Revision as of 10:41, 4 February 2013
Contents
Purpose
Function to read the first record contained in the specified XML file and return the number of fields in the record
Syntax
XMLFIRST(<XML filename>, <memvar1>, <memvar2>, <memvar3>, <array1>, <array2>)
See Also
COPY, FETCH, SELECT, SET XMLFORMAT, UPDATE, XML, XML_DECODE(), XML_ENCODE(), XML_GATHER(), XML_SCATTER(), XMLCOUNT(), XMLCREATEDTD(), XMLNEXT(), XMLVALIDATE()
Description
The XMLFIRST() function will read the first record contained in the specified XML file, returning the number of fields in the record.
| Parameters | Required | Default | Description |
|---|---|---|---|
| <XML filename> | Yes | None | The name of the XML file to read. |
| <memvar1> | Yes | None | The name of a memory variable that will return the XML target table name. Ignored if XMLFORMAT is ADO. |
| <memvar2> | Yes | None | The name of a memory variable that will return the transaction type for the record. Valid types are INSERT, UPDATE and DELETE. Ignored if XMLFORMAT is ADO. |
| <memvar3> | Yes | None | The name of a memory variable that will return the where condition for the transaction if it is an UPDATE or DELETE type. Ignored if XMLFORMAT is ADO. |
| <array1> | Yes | None | The name of an array that will be created automatically and loaded with the field names for the record. |
| <array2> | Yes | None | The name of an array that will be created created automatically and loaded with the data for each field in the record. |
The XMLFIRST() function will return -1 if it fails, as some transaction type can contain zero fields. The XML file format is set to ADO (Microsoft® ActiveX® Data Objects XML Format) by default. The SET XMLFORMAT command can be used to toggle the XML file format between ADO and Lianja.
Example
number = xmlfirst("sales.xml", target, trans, where, names, data) ? number 30
