SecureBlackbox 2020 Node.js Edition

Questions / Feedback?

SecretKeyValid Property

Indicates the validity status of the key.

Syntax

 pgpkeyring.getSecretKeyValid(index, [callback])

Possible Values

  0 (pkvStrictlyValid), 
  1 (pkvValid), 
  2 (pkvInvalid), 
  3 (pkvFailure), 
  4 (pkvUnknown)

Default Value

0

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 getSecretKeyValid([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 setSecretKeyValid([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

Indicates the validity status of the key.

pkvStrictlyValid0Strictly valid

pkvValid1Valid

pkvInvalid2Invalid

pkvFailure3Generic validation failure

pkvUnknown4Validity unknown

The index parameter specifies the index of the item in the array. The size of the array is controlled by the SecretKeyCount property.

This property is read-only and not available at design time.

Data Type

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 Node.js Edition - Version 20.0 [Build 8165]