Edit

Share via

Query.SaveAsXml(OutStream) Method

  • Article

Version: Available or changed with runtime version 1.0.

Saves the resulting data set of a query as XML

Syntax

[Ok := ]  Query.SaveAsXml(OutStream: OutStream)

Parameters

Query
 Type: Query
An instance of the Query data type.

OutStream
 Type: OutStream
The stream that you want to save the query as XML 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 streamed to the OutStream object designated by the OutStream 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

For example code on how to use Query.SaveAsXml with an OutStream object, see Query.SaveAsXml(Integer, OutStream) Method.

Query.SaveAsXml(Integer, OutStream) Method
Query Data Type
Get Started with AL
Developing Extensions