Click or drag to resize

SettingNodeGetValue Method

When reading this property for node with a primitive type setting, the optional Index parameter is ignored and the value is returned.

Namespace:  Kofax.OmniPageCSDK.IproPlus
Assembly:  Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntax
public Object GetValue(
	[OptionalAttribute] int Index
)

Parameters

Index (Optional)
Type: SystemInt32

Return Value

Type: Object
Remarks

If the setting holds an array, the whole array is returned unless the Index parameter contains a valid zero-based array index. In this case the requested array element is returned. If the Index is invalid, or the related node does not have a setting, a trappable error occurs.

When setting this property, the value of the associated setting (if any) is updated accordingly. If the node does not have a setting, or the associated setting is read-only, a trappable error occurs. If the setting holds an array, the addressed element or the whole array is updated according to the Index parameter. An existing array can be updated only with an array of the same size and type. If the setting holds a primitive type, the option Index optional parameter is ignored. If the setting type and the value being set are not consistent, an automatic conversion is attempted; a trappable error occurs if this fails.

See Also