InputFile Property

The file to process.

Syntax

 hash.getInputFile([callback])
 hash.setInputFile( inputFile, [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 getInputFile([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 setInputFile([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

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked are as follows:

InputFile
InputMessage

When a valid source is found the search stops.

Data Type

String