Breyta

Deila með

Query.SaveAsXml(Integer, Text) Method

  • Grein

Version: Available or changed with runtime version 1.0.

Saves the resulting data set of a query as an .xml file.

Note

This method is supported only in Business Central on-premises.

Syntax

[Ok := ]  Query.SaveAsXml(Number: Integer, FileName: Text)

Parameters

Number
 Type: Integer
The ID of the query object that you want to save as an .xml file. If the query that you specify does not exist, then a run-time error occurs.

FileName
 Type: Text
The path and name of the file that you want to save the query to.

Return Value

[Optional] Ok
 Type: Boolean
true if the SaveAsXml succeeded, otherwise false. If you omit this optional return value and the operation does not execute successfully, a runtime error will occur.

Remarks

When the SaveAsXML method is called, the dataset is generated and then saved in XML format in the file and location that is designated by the FileName parameter.

Open, Read, or Close semantics

The SaveAsXML method can be called at any place in the code and does not require that the Open, Read, or Close methods are called before it. For more information, see Open, Read, or Close semantics with the SaveAsXML method.

Example

The following example shows how to save a query with the name My Customer Query as an .xml file. The file is given the name myquery.xml and is saved on the c: drive of the computer running Dynamics 365 Business Central service.

var
    MyCustomerQuery: Query "My Customer Query";
    OK: Boolean;
    Text000: Label 'Query was not saved.';
begin
    OK := MyCustomerQuery.SaveAsXML(Query::MyCustomerQuery, 'c:\myquery.xml');  
    if not OK then  
      Error(Text000);  
end;

If the file cannot be saved, then the follow message appears:

Query not saved.

Query Data Type
Get Started with AL
Developing Extensions