PosTypeDescription Property

A description of the position type.

Syntax

 invstatement.getPosTypeDescription(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 getPosTypeDescription([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 setPosTypeDescription([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

A description of the position type. This is a string representation of the value returned by the PosType.

The types and their meanings are as follows:

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

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

Data Type

String