CapDesc Property

Description

Gets the description for the specified constant for the current capability.

Property Type

Read-only property

Syntax

Visual Basic
Public Property CapDesc( _ ByVal Index As Long _ ) As String

Parameters

Index: A long value which represents the zero-based index value of the item.

Return Type

A string value which represents the description for the specified constant for the current capability.

Remarks

This is a runtime, read-only property.

When CapType = TWCAP_ENUM, the Source may return a list of constants that signify settings.

For example, if Capability = TWCAP_PIXELTYPE, and the Source returns a TWCAP_ENUM containing the constants, TWPT_BW (0), TWPT_GRAY (1), TWPT_RGB (2) a description of each may be obtained with the CapDesc property.

TwainPRO.CapDesc( TWPT_BW ) would return "Black & White". This can be used for filling a listbox or combobox with descriptions of available values instead of just the constants.