This documentation is archived and is not being maintained.

IDataAdapter Interface

Allows an object to implement a DataAdapter, and represents a set of methods and mapping action-related properties used to fill and refresh a DataSet and update a data source.

For a list of all members of this type, see IDataAdapter Members.

[Visual Basic]
Public Interface IDataAdapter
public interface IDataAdapter
public __gc __interface IDataAdapter
public interface IDataAdapter

Classes that Implement IDataAdapter

Class Description
DataAdapter Represents a set of data commands and a database connection that are used to fill the DataSet and update the data source.


The IDataAdapter interface allows an inheriting class to implement a DataAdapter class, which represents the bridge between a data source and a DataSet. For more information about DataAdapter classes, see Populating a DataSet from a DataAdapter. For more information about implementing .NET Framework data providers, see Implementing a .NET Framework Data Provider.

An application does not create an instance of the IDbDataAdapter interface directly, but implements an instance of a class that inherits IDbDataAdapter.

Classes that inherit IDataAdapter must implement the inherited members, and typically define additional members to add provider-specific functionality. For example, the IDataAdapter interface defines a Fill method that takes a DataSet as a parameter. In turn, the OleDbDataAdapter class inherits the Fill method, and also defines two additional overloads of the Fill method that take an ADO Recordset object as a parameter.

Notes to Implementers:  To promote consistency among .NET Framework data providers, name the inheriting class in the form Prv DataAdapter where Prv is the uniform prefix given to all classes in a specific .NET Framework data provider namespace. For example, Sql is the prefix of the SqlDataAdapter class in the System.Data.SqlClient namespace.

When you inherit from the IDataAdapter interface, you should implement the following constructors:

Item Description
PrvDataAdapter() Initializes a new instance of the PrvDataAdapter class.
PrvDataAdapter(PrvCommand selectCommand) Initializes a new instance of the PrvDataAdapter class with the specified SQL SELECT statement.
PrvDataAdapter(string selectCommandText, string selectConnectionString) Initializes a new instance of the PrvDataAdapter class with an SQL SELECT statement and a connection string.
PrvDataAdapter(string selectCommandText, PrvConnection selectConnection) Initializes a new instance of the PrvDataAdapter class with an SQL SELECT statement and a PrvConnection object.


[Visual Basic, C#, C++] The following example uses the derived classes, SqlCommand, SqlDataAdapter and SqlConnection, to select records from a database. The filled DataSet is then returned. To accomplish this, the method is passed an initialized DataSet, a connection string, and a query string that is a Transact-SQL SELECT statement.

[Visual Basic] 
Public Function SelectSqlSrvRows(dataSet As DataSet, connection As String, query As String) As DataSet
    Dim conn As New SqlConnection(connection)
    Dim adapter As New SqlDataAdapter()
    adapter.SelectCommand = new SqlCommand(query, conn)
    Return dataset
End Function

public DataSet SelectSqlSrvRows(DataSet dataset,string connection,string query) 
    SqlConnection conn = new SqlConnection(connection);
    SqlDataAdapter adapter = new SqlDataAdapter();
    adapter.SelectCommand = new SqlCommand(query, conn);
    return dataset;

DataSet* SelectSqlSrvRows(DataSet* dataset,String* connection,String* query) 
    SqlConnection* conn = new SqlConnection(connection);
    SqlDataAdapter* adapter = new SqlDataAdapter();
    adapter->SelectCommand = new SqlCommand(query, conn);
    return dataset;

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.


Namespace: System.Data

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

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

See Also

IDataAdapter Members | System.Data Namespace