SetClientFileEntry Method

Commits the file entry details to the class.

Syntax

sftpserver.setClientFileEntry(connectionID, handle, [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

Use this method to commit the file entry details configured in ClientFileEntry property to the server objectin a thread-safe way. Pass the client's connection ID via ConnectionID property, and the file entry's handlevia Handle.