This method retrieves the possible setting values for a specified property of the scan device.

[Visual Basic] Public Function GetCapabilityEnumToString(ByVal capability As Newtone.ImageKit.ScanCapability) As String()
[C#] public string[] GetCapabilityEnumToString(Newtone.ImageKit.ScanCapability capability);

Parameters

capability
The number for the retrieved capability (Value is of type ScanCapability enumeration)

Return Value

An array of supported values (Returns null [C#] or Nothing [Visual Basic] if unsuccessful).

Explanation

The GetCapabilityEnumToString method retrieves the possible setting values for a specified property of the scan device. To retrieve the possible setting values for a property it is first necessary to set the DataSourceName property. If the DataSourceName property is blank then please execute the SelectDataSource method prior to executing the GetCapabilityEnumToString method. (Note: If the OpenDataSource method is executed prior to the GetCapabilityEnumToString method the the DataSourceName is disabled and the open datasource is used).

To execute the GetCapabilityEnumToString method you must first execute the Initialize method. If the OpenDataSource method is executed prior to executing the GetCapabilityEnumToString method then the open datasource cannot be used by another application until that datasource (scan device) is closed.

After executing this method, the values are set into the ContainerType, CurrentIndex, and DefaultIndex properties.

Content of the Returned Value

Parameter Return Value
Halftone The possible setting values

When the capability is Halftone, the returned values reflect the possible halftone values that can be set.

When ContainerType = 3, the value is returned but the CurrentIndex and DefaultIndex are not enabled.
When ContainerType = 4, the value is returned and the array index referring to the CurrentIndex and DefaultIndex contain the current and default values.
When ContainerType = 5, the array index 0 contains the current value
When ContainerType = 6, there is no return value.

See Also

Scan Class | Scan Members

The ImageKit.NET3 is created by Newtone Corporation