IP*Works! Encrypt V9 - Online Help
IP*Works! Encrypt V9
Questions / Feedback?

KeyEncoded Property

The key.

Syntax

 keymgr.getKeyEncoded([callback])
 keymgr.setKeyEncoded( keyEncoded_Buffer, [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 getKeyEncoded([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 setKeyEncoded([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

The key. This property is used to assign a specific key. The KeyUserId properties may also be used to specify a key.

This property is not available at design time.

Data Type

Buffer

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 9.0.6240.0