UpdateFiles Method

Updates a selection of files in the archive.

Syntax

archivewriter.updateFiles(folder, localPath, addMissingFiles, removeMissingFiles, recursive, [callback])

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 this 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 method is a powerful way to update a subset of files in the archive in accordance witha specified criteria.

Pass an archive-local name of the folder to update via the Folder parameter,and the system-local version of the same folder via the LocalPath parameter.Set AddMissingFiles and RemoveMissingFiles as needed to force inclusionof files missing from the archive, or removal of files missing locally, accordingly.

The Recursive parameter specifies whether the directory should be browsed recursively.