<Source>.ExportXML (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Exporting the query content

Exporting a single record

ErrorStatusModification

FilterIncludedBetween

MigrateLinkedCompositeKey

Exporting the query content
Exporting a single record
Array items
Miscellaneous

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Source>.ExportXML (Function)

In french: <Source>.ExporteXML

Not available with these kinds of connection

Exports the records found in a data file (HFSQL or OLE DB), view or query to an XML file.

Remark: A style sheet (".XLS" file) is automatically generated when creating the XML file. Remark: From version 19, HFSQL is the new name of HyperFileSQL.

Versions 22 and later

This function is now available for iPhone/iPad applications.

This function is now available in Universal Windows 10 App mode.

This function is now available in Android Widget mode.

This function is now available for Java applications.

This function is now available for Android applications.

New in version 22

This function is now available for iPhone/iPad applications.

This function is now available in Universal Windows 10 App mode.

This function is now available in Android Widget mode.

This function is now available for Java applications.

This function is now available for Android applications.

This function is now available for iPhone/iPad applications.

This function is now available in Universal Windows 10 App mode.

This function is now available in Android Widget mode.

This function is now available for Java applications.

This function is now available for Android applications.

Example

// Export all customers
Customer.ExportXML("C:\TEMP\Customer.xml", hExpCreation)

Syntax

<Result> = <Source>.ExportXML([<Path of XML file> [, <Items to export>]] [, <Options> [, <Progress Bar>]])

<Result>: Boolean

True if the operation was performed,
False if a problem occurred. HError is used to identify the error.

<Source>: Type corresponding to the specified source

Name of data file, view or query used.

<Path of XML file>: Optional character string

Full path of XML file to generate.
If this parameter is not specified, a <Source>.XML file will be generated in the current directory.

<Items to export>: Optional character string

List of names of items to export. The names are delimited by single quotes and separated by commas or CR characters. The names of composite key items, binary items and binary memo items are ignored.
If this parameter corresponds to an empty string (""), all the items in the data file (except composite key, binary and binary memo items) are exported.

<Options>: Optional Integer constant

Mode for creating the XML file:
hExpCreation If the XML export file already exists, it is overwritten. An error occurs if this option is not specified and if the XML file exists.
hExpBreakable The export can be interrupted by pressing Esc.
If the export is interrupted, the XML file is valid and it only contains the records exported before the interruption.
hExpNormal
(default value) Standard operating mode.
hExpWithoutXSL The style sheet (".XSL" file) is not created.

<Progress Bar>: Optional control name or window name

Name of Progress Bar control or name of window used to show the progress of file creation.

Remarks

Exporting the query content

To export the query content, you must initialize the query (0) before using <Source>.ExportXML.

Exporting a single record

To export a single record to an XML string, use <Source>.RecordToXML.

Array items

If one of the exported items is an array item, each element of the array item is exported in a new level:

<FILE>

 <ITEM1>data of item 1</ITEM1>

 <ITEM2>data of item 2</ITEM2>

 <ARRITEM>

  <ARRITEM_1>data of element 1</ARRITEM_1>

  <ARRITEM_2>data of element 2</ARRITEM_2>

  <ARRITEM_3>data of element 3</ARRITEM_3>

 </ARRITEM>

...

</FILE>

Reminder: Composite key, binary memo or binary items are ignored.

Miscellaneous

The document entity of the generated XML file is named HF_DOCUMENT.

Component: wd260hf.dll