IPWorks WebSockets 2020 Node.js Edition

Questions / Feedback?

ExportPrivateKey Property

Whether to export the private key.

Syntax

 certmgr.getExportPrivateKey([callback])
 certmgr.setExportPrivateKey( exportPrivateKey, [callback])

Default Value

TRUE

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 getExportPrivateKey([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 setExportPrivateKey([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

This property controls whether the private key is exported when ExportCertificate is called.

If set to True (default) the private key is exported. If set to False, only the public key is exported.

Data Type

Boolean

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks WebSockets 2020 Node.js Edition - Version 20.0 [Build 7721]