IPWorks Encrypt 2020 Node.js Edition

Questions / Feedback?

EncryptedDataDetailXMLElement Property

This property specifies the XPath to the element which will be encrypted.

Syntax

 xmlencrypt.getEncryptedDataDetailXMLElement(index, [callback])
 xmlencrypt.setEncryptedDataDetailXMLElement(index,  encryptedDataDetailXMLElement, [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 getEncryptedDataDetailXMLElement([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 setEncryptedDataDetailXMLElement([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 XPath to the element which will be encrypted. For instance:

/root/myElement XPath syntax
/root/[1] XPath syntax using an index
/root/ns:myElement XPath syntax where the element has a namespace
myElement Just the element name
@id=myid Attribute selector: This will select an element with an attribute "id" whose value is "myid".
/root/myElement[1]/ns:name2[@attr=attrValue] XPath syntax using an index and attribute selector

The index parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptedDataDetailCount property.

This property is not available at design time.

Data Type

String

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