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




index
Index into the array of values.
Gets the value of the TwainArrayCapability object.

Syntax

Visual Basic (Declaration) 
Public Function GetValue( _
   ByVal index As Integer _
) As Object
Visual Basic (Usage)Copy Code
Dim instance As TwainArrayCapability
Dim index As Integer
Dim value As Object
 
value = instance.GetValue(index)
C# 
public object GetValue( 
   int index
)
Managed Extensions for C++ 
public: Object* GetValue( 
   int index
)
C++/CLI 
public:
Object^ GetValue( 
   int index
)

Parameters

index
Index into the array of values.

Return Value

The value of the TwainArrayCapability object from the specified index.

Example

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

   Dim twCap As TwainCapability = session.GetCapability(TwainCapabilityType.ImageFilter, TwainGetCapabilityMode.GetValues)

   If twCap.Information.ContainerType <> TwainContainerType.Array Then
      Dim arrayCap As TwainArrayCapability = twCap.ArrayCapability
      Dim i As Integer

      For i = 0 To arrayCap.Count - 1
         Dim capVal As TwainCapabilityValue = CType(arrayCap.GetValue(i), TwainCapabilityValue)
         Dim msg As String = String.Format("Capability Value(%d) = %s", i, capVal.ToString())
         MessageBox.Show(msg)
      Next
   Else
      MessageBox.Show("Container type is not array")
   End If

   session.Shutdown()
End Sub
C#Copy Code
public void TwainArrayCapabilityGetValueExample(IWin32Window parent) 
{ 
   TwainSession session = new TwainSession(); 
   session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None); 
 
   TwainCapability twCap = session.GetCapability(TwainCapabilityType.ImageFilter, TwainGetCapabilityMode.GetValues); 
 
   if (twCap.Information.ContainerType == TwainContainerType.Array) 
   { 
      TwainArrayCapability arrayCap = twCap.ArrayCapability; 
 
      for (int i = 0; i < arrayCap.Count; i++) 
      { 
         TwainCapabilityValue capVal = (TwainCapabilityValue)arrayCap.GetValue(i); 
         string msg = string.Format("Capability Value(%d) = %s", i, capVal.ToString()); 
         MessageBox.Show(msg); 
      } 
   } 
   else 
      MessageBox.Show("Container type is not array"); 
 
   session.Shutdown(); 
}

Remarks

index must be between 0 and Count.
For more information, refer to How to Work with the Container.

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