IPWorks OpenPGP 2020 Node.js Edition

Questions / Feedback?

ExportedCert Property

The exported certificate string.

Syntax

 certmgr.getExportedCert([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 getExportedCert([callback]) method is defined as:

function(err, buffer){ }

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

'buffer' is the value returned by the method.

The callback for the setExportedCert([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 holds the exported certificate if it was not exported to a file.

When calling ExportCertificate if the CertFile parameter is empty string the certificate will be exported as a string and available in this property. This allows certificate data to be exported without writing any data to disk.

When ExportFormat is set to PFX or P7B the EncodeExportedCert setting controls whether the value is binary or base64 encoded.

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

Data Type

Buffer

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