Protection Property

Specifies a password protection level.

Syntax

 pgpwriter.getProtection([callback])
 pgpwriter.setProtection( protection, [callback])

Possible Values

  0 (pptNone), 
  1 (pptLow), 
  2 (pptNormal), 
  3 (pptHigh)

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 getProtection([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 setProtection([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 specifies the complexity of key derivation function for password-protected documents.

Allowed values:

Data Type

Integer