EntryPropertiesXPath Property

The XPath of the OData entry property.

Syntax

 odata.getEntryPropertiesXPath(index, [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 getEntryPropertiesXPath([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 setEntryPropertiesXPath([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 XPath of the OData entry property. This value can be used to set XPath or can be used within UpdateProperty to update a specific property.

The size of the array is controlled by the EntryPropertiesCount property.

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

Data Type

String