TwainGetCapDefaultString Method (GdPictureImaging)

In This Topic

Returns as string, the default value of a TWAIN capability.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Function TwainGetCapDefaultString( _
   ByVal Cap As TwainCapabilities, _
   ByRef CurrentValue As String _
) As Boolean

public bool TwainGetCapDefaultString( 
   TwainCapabilities Cap,
   ref string CurrentValue
)

public function TwainGetCapDefaultString( 
    Cap: TwainCapabilities;
   var  CurrentValue: String
): Boolean;

public function TwainGetCapDefaultString( 
   Cap : TwainCapabilities,
   CurrentValue : String
) : boolean;

public: bool TwainGetCapDefaultString( 
   TwainCapabilities Cap,
   ref string* CurrentValue
)

public:
bool TwainGetCapDefaultString( 
   TwainCapabilities Cap,
   String^% CurrentValue
)

Parameters

Cap: A member of the TwainCapabilities enumeration.
CurrentValue: Returns the default value of the specified TWAIN capability.

Return Value

True if success, else False -> Use TwainGetLastResultCode() and TwainGetLastConditionCode() methods for diagnosing the error.

Remarks

Before using this method check that the TWAIN state is >= 4 (TWAIN_SOURCE_OPEN) To get the TWAIN state, use the TwainGetState() method. This method can be used to retrieve the following types of capabilities: TWTY_STR32, TWTY_STR64, TWTY_STR128, TWTY_STR255 . You can determine the type of each TWAIN capability using the TwainGetCapItemType method or looking the twain references from http://www.twain.org

Reference

GdPictureImaging Class
GdPictureImaging Members
TwainGetCapItemType Method
TwainGetState Method
TwainSetCapCurrentString Method
TwainGetLastConditionCode Method
TwainGetLastResultCode Method