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

SetEntryProperty Method

Set an OData entry property.

Syntax

odata.setEntryProperty(XPath, value, [callback])

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 this 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 method is intended for extending functionality of the OData class and will set the value of the entry property (specified by XPath) to the specified Value. Therefore the value of the corresponding property will be updated within EntryProperties.

XPath is the XPath of the element or attribute according to the following convention: entry[x]/element. When EntryIndex is set to an index greater than or equal to zero, a relative path can also be used: property. When a relative path is specified, the class will use the specified EntryIndex along with the property specified to update the EntryProperty value.

entry[x] is the feed's xth entry (or any other root level child), where the indexer x starts at 1.

property is any child of the properties element. For example:


	ODataControl.SetEntryProperty("entry[5]/content/properties/Name", "MyNewName")

Here is an example using a relative path to retrieve properties of the first feed entry:

	ODataControl.EntryIndex = 1
	ODataControl.SetEntryProperty("Name", "MyNewName")
	ODataControl.SetEntryProperty("Address/State", "NC")

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0