LocalFile Property

The path to a local file used for DAV operations.

Syntax

 webdav.getLocalFile([callback])
 webdav.setLocalFile( localFile, [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 getLocalFile([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 setLocalFile([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

After a GetResource operation, LocalFile will contain the contents of the resource.

For a PutResource operation, LocalFile contains the data that will be uploaded to the server.

If LocalFile is empty then the received data is provided through the Transfer event.

Data Type

String