Password Property
An optional password to further protect data.
Syntax
dpapi.getPassword([callback]) dpapi.setPassword( password, [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 getPassword([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 setPassword([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 may be set to a password to protect the data further.
When protecting data without specifying a password any application running under the same user account can unprotect the data. By specifying a password another piece of information is required to unprotect the data.
This may be set before calling Protect. If a password was specified when protecting data it must be set before calling Unprotect.
This setting is not applicable when UseCNG is set to True.
Data Type
String