Dynamsoft Home|Product Home

CapCurrentIndex Property

Description

Sets or returns the index (0-based) of a list to indicate the Current Value when the value of the CapType property is TWON_ENUMERATION. If the data type of the capability is String, the list is in CapItemsString property. For other data types, the list is in CapItems property. This is a runtime property.

Data type

Long

Syntax

ObjectName. CapCurrentIndex

Remarks

Reading this property after calling CapGet() method. After setting this property, call CapSet() method to actually set the value.

The CapCurrentIndex property is 0-based.

It is valid only when the CapType property is TWON_ENUMERATION.

For information of which properties are valid for different container types, please refer to CapType property.

When an error occurs and IfThrowException property is TRUE, an exception will be thrown. Check ErrorCode property and ErrorString property for error information.

See also

Capability property, CapDefaultIndex property, CapItems property, CapItemsString property, CapNumItems property, CapType property

Sample code

Refer to Setting Capability with TW_ENUMERATION, Reading Value(s) from Capability Negotiation.