OutputFile Property

The path to a local file where the output will be written. If the file exists, it is overwritten.

Syntax

 xmlw.getOutputFile([callback])
 xmlw.setOutputFile( outputFile, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getOutputFile([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setOutputFile([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

If specified, the output of the class will be written to the OutputFile.

If not specified the output will be buffered in memory and can be retrieved using OutputData.

Data Type

String