Difference between revisions of "XMLFIRST()"
Yvonnemilne (Talk | contribs) |
Yvonnemilne (Talk | contribs) |
||
| (One intermediate revision by one user not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
| − | |||
| − | |||
==Purpose== | ==Purpose== | ||
Function to read the first record contained in the specified XML file and return the number of fields in the record | Function to read the first record contained in the specified XML file and return the number of fields in the record | ||
| Line 12: | Line 8: | ||
==See Also== | ==See Also== | ||
| − | [[COPY]], [[FETCH]], [[SQL SELECT|SELECT]], [[SET XMLFORMAT]], [[SQL UPDATE|UPDATE]], [[XMLCOUNT()]], [[XMLCREATEDTD()]], [[XMLNEXT()]], [[XMLVALIDATE()]] | + | [[COPY]], [[FETCH]], [[SQL SELECT|SELECT]], [[SET XMLFORMAT]], [[SQL UPDATE|UPDATE]], [[XML]], [[XML_DECODE()]], [[XML_ENCODE()]], [[XML_GATHER()]], [[XML_SCATTER()]], [[XMLCOUNT()]], [[XMLCREATEDTD()]], [[XMLNEXT()]], [[XMLVALIDATE()]] |
| Line 49: | Line 45: | ||
==Products== | ==Products== | ||
| − | Recital | + | Recital, Recital Server |
[[Category:Documentation]] | [[Category:Documentation]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
[[Category:XML]] | [[Category:XML]] | ||
[[Category:XML Functions]] | [[Category:XML Functions]] | ||
Latest revision as of 14:20, 19 November 2009
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 Recital.
Example
number = xmlfirst("sales.xml", target, trans, where, names, data) ? number 30
Products
Recital, Recital Server
