PublicKeyPassphraseValid Property
Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
Syntax
pgpkeyring.getPublicKeyPassphraseValid(index, [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 getPublicKeyPassphraseValid([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 setPublicKeyPassphraseValid([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
Use this property to check whether the specified PublicKeyPassphrase is valid and can be used to unlock the secret key.
The index parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean