Leadtools.Twain Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.8.31
GetCapability Method
See Also  Example
Leadtools.Twain Namespace > TwainSession Class : GetCapability Method




type
The capability to get.
mode
The capability values to get.
Gets the TwainCapability value at the specified index from the array of capabilities supported by the selected TWAIN source.

Syntax

Visual Basic (Declaration) 
Public Function GetCapability( _
   ByVal type As TwainCapabilityType, _
   ByVal mode As TwainGetCapabilityMode _
) As TwainCapability
Visual Basic (Usage)Copy Code
Dim instance As TwainSession
Dim type As TwainCapabilityType
Dim mode As TwainGetCapabilityMode
Dim value As TwainCapability
 
value = instance.GetCapability(type, mode)
C# 
public TwainCapability GetCapability( 
   TwainCapabilityType type,
   TwainGetCapabilityMode mode
)
Managed Extensions for C++ 
public: TwainCapability* GetCapability( 
   TwainCapabilityType type,
   TwainGetCapabilityMode mode
)
C++/CLI 
public:
TwainCapability^ GetCapability( 
   TwainCapabilityType type,
   TwainGetCapabilityMode mode
)

Parameters

type
The capability to get.
mode
The capability values to get.

Return Value

A TwainCapability object that represents the specified capability value(s).

Example

Visual BasicCopy Code
Public Sub GetCapabilityExample(ByVal parent As IWin32Window)
   Dim session As TwainSession = New TwainSession()
   session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None)

   Dim twCap As TwainCapability
   twCap = session.GetCapability(TwainCapabilityType.ImageUnits, TwainGetCapabilityMode.GetCurrent)
   If twCap Is Nothing Then
      MessageBox.Show("Error Getting Capability")
   End If

   session.Shutdown()
End Sub
C#Copy Code
public void GetCapabilityExample(IWin32Window parent) 
{ 
   TwainSession session = new TwainSession(); 
   session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None); 
 
   TwainCapability twCap; 
   twCap = session.GetCapability(TwainCapabilityType.ImageUnits, TwainGetCapabilityMode.GetCurrent); 
   if (twCap == null) 
      MessageBox.Show("Error Getting Capability"); 
 
   session.Shutdown(); 
}

Remarks

For more information, refer to Freeing the TWAIN Session.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also