GetCapability Method

Gets the TwainCapability value at the specified index from the array of capabilities supported by the selected TWAIN source.

Syntax

C#
Visual Basic
Java
Objective-C
C++

public TwainCapability GetCapability( 
   TwainCapabilityType type,
   TwainGetCapabilityMode mode
)

'Declaration

Public Function GetCapability( _
   ByVal type As TwainCapabilityType, _
   ByVal mode As TwainGetCapabilityMode _
) As TwainCapability

'Usage

Dim instance As TwainSession
Dim type As TwainCapabilityType
Dim mode As TwainGetCapabilityMode
Dim value As TwainCapability
 
value = instance.GetCapability(type, mode)

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).

Remarks

For more information, refer to Freeing the TWAIN Session.

Example

C#
Visual Basic
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

Imports Leadtools
Imports Leadtools.Twain

Public Sub GetCapabilityExample(ByVal parent As IntPtr)
   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

using Leadtools;
using Leadtools.Twain;

public void GetCapabilityExample(IntPtr 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();
}

Requirements

Target Platforms

Reference

TwainSession Class
TwainSession Members
QuerySupportedCapabilities Method
SetCapability Method
QueryCapability Method