IPWorks OpenPGP 2020 Node.js Edition

Questions / Feedback?

ListKeys Method

List keysets in a CSP.

Syntax

certmgr.listKeys([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, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method lists the keys (public/private key pairs) in a Cryptographic Service Provider (CSP). The results are provided through the KeyList event.

The same information is also returned upon method completion as a set of lines, one per key, with each line containing the following information separated by Tab characters: KeyContainer, KeyType, AlgId, KeyLen.

NOTE: This functionality is only available in Windows.

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