SchemaTypeFieldIndex Property

The index of the current field (property) in an OData schema complex type.

Syntax

 odata.getSchemaTypeFieldIndex([callback])
 odata.setSchemaTypeFieldIndex( schemaTypeFieldIndex, [callback])

Default Value

0

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 getSchemaTypeFieldIndex([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 setSchemaTypeFieldIndex([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 is used to specify a field (property) within a complex type. Once set, SchemaTypeField will be populated.

This property is not available at design time.

Data Type

Integer