EntryPropertiesName Property

The Name of the OData entry element.

Syntax

 odata.getEntryPropertiesName(index, [callback])
 odata.setEntryPropertiesName(index,  entryPropertiesName, [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 getEntryPropertiesName([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 setEntryPropertiesName([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 Name of the OData entry element.

Note: For properties derived from a complex type, the name of the property and it's sub-property will be separated by '/'. For example, let's say you have a property called "MailingAddress" that is derived from a complex type called "Address". The "Address" complex type contains a property called "City". This particular property will be returned as "MailingAddress/City".

Setting this property to empty string prior to calling UpdateEntry will result in the item not being sent in the update request. Thus removing it from the OData entry.

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

This property is not available at design time.

Data Type

String