LocalFile Property

The path to a local file for uploading or downloading blob data. When downloading, if the file exists it is overwritten (optional).

Syntax

 azureblob.getLocalFile([callback])
 azureblob.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

This property is used when retrieving a blob via GetBlob or when creating a blob via CreateBlob.

When GetBlob is called and LocalFile is set to a valid path, the retrieved blob data will be written directly to the specified file. If the file already exists, Overwrite will determine if the file gets overwritten.

When CreateBlob is called and LocalFile is set to a valid path, the specified file will be used to create the blob.

If LocalFile is an empty string, all data either to be sent or received is provided via the BlobData property.

Data Type

String