DataTableCollection.IndexOf Method (String)

 

Gets the index in the collection of the DataTable object with the specified name.

Namespace:   System.Data
Assembly:  System.Data (in System.Data.dll)

Public Function IndexOf (
	tableName As String
) As Integer

Parameters

tableName
Type: System.String

The name of the DataTable object to look for.

Return Value

Type: System.Int32

The zero-based index of the DataTable with the specified name, or -1 if the table does not exist in the collection.

System_CAPS_noteNote

Returns -1 when two or more tables have the same name but different namespaces. The call does not succeed if there is any ambiguity when matching a table name to exactly one table.

You specify the name of the DataTable object by using the TableName property.

The following example returns the index of a named table in the DataTableCollection.

Private Sub GetIndexes()
   ' Get the DataSet of a DataGrid.
   Dim thisDataSet As DataSet = CType(DataGrid1.DataSource, DataSet)

   ' Get the DataTableCollection through the Tables property.
   Dim tables As DataTableCollection = thisDataSet.Tables

   ' Get the index of the table named "Authors", if it exists.
   If tables.Contains("Authors") Then
      System.Diagnostics.Debug.WriteLine(tables.IndexOf("Authors"))
   End If
End Sub

.NET Framework
Available since 1.1
Return to top
Show: