SSHSettingsUseAuthAgent Property
Enables or disables the use of external key agent, such as Putty key agent.
Syntax
sftpclient.getSSHSettingsUseAuthAgent([callback]) sftpclient.setSSHSettingsUseAuthAgent( SSHSettingsUseAuthAgent, [callback])
Default Value
FALSE
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 getSSHSettingsUseAuthAgent([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 setSSHSettingsUseAuthAgent([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
Enables or disables the use of external key agent, such as Putty key agent.
Data Type
Boolean