GetClientFileEntry Method

Acquires file entry details from the class.

Syntax

sftpserver.getClientFileEntry(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 acquire the details of a file entry from the server in atomic and thread-safe way.After this method completes, the entry details will be propagated in ClientFileEntry property.

When calling this method, pass the client connection ID in ConnectionID property, and theopened file handle (if needed) in Handle property.