SSHCertStorePassword Property

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

Syntax

 sftp.getSSHCertStorePassword([callback])
 sftp.setSSHCertStorePassword( SSHCertStorePassword, [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 getSSHCertStorePassword([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 setSSHCertStorePassword([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

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

Data Type

String