LEADTOOLS Multimedia (Leadtools.Multimedia assembly) Send comments on this topic. | Back to Introduction | Help Version 17.0.3.22
IndexOf(String) Method
See Also 
Leadtools.Multimedia Namespace > AudioInputs Class > IndexOf Method : IndexOf(String) Method



name
The AudioInput name to locate in the collection.
name
The AudioInput name to locate in the collection.
Determines the index of a specific AudioInput name in the collection.

Syntax

Visual Basic (Declaration) 
Overloads Public Function IndexOf( _
   ByVal name As String _
) As Integer
Visual Basic (Usage)Copy Code
Dim instance As AudioInputs
Dim name As String
Dim value As Integer
 
value = instance.IndexOf(name)
C# 
public int IndexOf( 
   string name
)
C++/CLI 
public:
int IndexOf( 
   String^ name
) 

Parameters

name
The AudioInput name to locate in the collection.

Return Value

The zero-based index of the found item; otherwise -1 if no item found.

Example

Visual BasicCopy Code
Public _result As Boolean = False
Public _form As CaptureCtrlForm = New CaptureCtrlForm()
Public Sub IndexContainsExample()
   Try
      ' reference the form capture control
      Dim capturectrl As CaptureCtrl = _form.CaptureCtrl

      ' set an audio device first, you should use your audio device name here
      If capturectrl.AudioDevices("USB") Is Nothing Then
         Throw New Exception("No USB audio device available")
      End If

      capturectrl.AudioDevices("USB").Selected = True

      ' reference the form capture control's audio inputs
      Dim inputs As AudioInputs = capturectrl.AudioInputs

      ' check for the master volume input
      Dim i As Integer = inputs.IndexOf("Master Volume")

      ' access the input via the collection indexer
      Dim ai As AudioInput = inputs(i)

      ' check if the collection contains this input 
      ' (it should we just got it with IndexOf above!)
      If inputs.Contains(ai) Then
         ' set the result to what we expect
         _result = True
      End If
   Catch e1 As Exception
      _result = False
   End Try
End Sub
C#Copy Code
public bool _result = false;
public CaptureCtrlForm _form = new CaptureCtrlForm();
public void IndexContainsExample()
{
   try
   {
      // reference the form capture control
      CaptureCtrl capturectrl = _form.CaptureCtrl;

      // set an audio device first, you should use your audio device name here
      if (capturectrl.AudioDevices["USB"] == null)
         throw new Exception("No USB audio device available");

      capturectrl.AudioDevices["USB"].Selected = true;

      // reference the form capture control's audio inputs
      AudioInputs inputs = capturectrl.AudioInputs;

      // check for the master volume input
      int i = inputs.IndexOf("Master Volume");

      // access the input via the collection indexer
      AudioInput ai = inputs[i];

      // check if the collection contains this input 
      // (it should we just got it with IndexOf above!)
      if (inputs.Contains(ai))
      {
         // set the result to what we expect
         _result = true;
      }
   }
   catch (Exception)
   {
      _result = false;
   }
}

Remarks

This method searches the underlying item collection to locate the item name specified.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also