IDataParameter Gränssnitt

Definition

Namnområde:
System.Data
Sammansättning:
System.Data.dll
Sammansättning:
netstandard.dll

Representerar en parameter till ett kommandoobjekt och eventuellt dess mappning till DataSet kolumner. och implementeras av .NET dataleverantörer som har åtkomst till datakällor.

public interface class IDataParameter
public interface IDataParameter
type IDataParameter = interface
Public Interface IDataParameter
Härledda

Exempel

I följande exempel skapas flera instanser av den härledda klassen, SqlParameter, via SqlParameterCollection samlingen i SqlDataAdapter. Dessa parametrar används för att välja data från datakällan och placera data i DataSet. Det här exemplet förutsätter att en DataSet och en SqlDataAdapter redan har skapats med lämpligt schema, kommandon och anslutning.

public void AddSqlParameters()
{
// ...
// create categoriesDataSet and categoriesAdapter
// ...

  categoriesAdapter.SelectCommand.Parameters.Add(
    "@CategoryName", SqlDbType.VarChar, 80).Value = "toasters";
  categoriesAdapter.SelectCommand.Parameters.Add(
    "@SerialNum", SqlDbType.Int).Value = 239;
  categoriesAdapter.Fill(categoriesDataSet);
}

Public Sub AddSqlParameters()
    ' ...
    ' create categoriesDataSet and categoriesAdapter
    ' ...
    categoriesAdapter.SelectCommand.Parameters.Add( _
        "@CategoryName", SqlDbType.VarChar, 80).Value = "toasters"
    categoriesAdapter.SelectCommand.Parameters.Add( _
        "@SerialNum", SqlDbType.Int).Value = 239
    
    categoriesAdapter.Fill(categoriesDataSet)
End Sub

Kommentarer

Med IDataParameter gränssnittet kan en ärvande klass implementera en parameterklass som representerar en parameter till ett kommandoobjekt. Mer information om parameterklasser finns i Konfigurera parametrar och parameterdatatyper.

Ett program skapar inte en instans av IDataParameter gränssnittet direkt, men skapar en instans av en klass som ärver IDataParameter.

Klasser som ärver IDataParameter måste implementera de ärvda medlemmarna och vanligtvis definiera ytterligare medlemmar för att lägga till providerspecifika funktioner. Gränssnittet definierar DbType till exempel IDataParameter egenskapen. Klassen ärver i sin tur den OleDbParameter här egenskapen och definierar OleDbType även egenskapen.

Anteckningar till implementerare

Om du vill främja konsekvens mellan .NET Framework-dataprovidrar namnger du ärvningsklassen i formuläret Prv Parameter där Prv är det enhetliga prefixet som ges till alla klasser i ett specifikt .NET Framework-dataprovidernamnområde. Är till exempel Sql prefixet för SqlCommand klassen i System.Data.SqlClient namnområdet.

När du ärver från IDataParameter gränssnittet bör du implementera följande konstruktorer:

Artikel Beskrivning
PrvParameter() Initierar en ny instans av parameterklassen.
PrvParameter(strängnamn, PrvDbType dataType) Initierar en ny instans av parameterklassen med parameternamnet och datatypen.
PrvParameter(strängnamn, objektvärde) Initierar en ny instans av parameterklassen med parameternamnet och ett objekt som är värdet för parametern.
PrvParameter(strängnamn, PrvDbType dataType, int size) Initierar en ny instans av parameterklassen med parameternamnet, datatypen och bredden.
PrvParameter(strängnamn, PrvDbType dataType, int size, string srcColumn) Initierar en ny instans av klassen DbParameter med parameternamnet, datatypen, bredden och källkolumnnamnet.
PrvParameter(string parameterName, PrvDbType dbType, int size, ParameterDirection direction, Boolean isNullable, Byte precision, Byte scale, string srcColumn, DataRowVersion srcVersion, object value) Initierar en ny instans av OleDbParameter klassen med parameternamnet, datatypen, bredden, källkolumnnamnet, parameterriktningen, numerisk precision och andra egenskaper.

Egenskaper

Name Description
DbType

Hämtar eller anger DbType parametern .
Direction

Hämtar eller anger ett värde som anger om parametern endast är indata, endast utdata, dubbelriktad eller en returvärdeparameter för lagrad procedur.
IsNullable

Hämtar ett värde som anger om parametern accepterar null-värden.
ParameterName

Hämtar eller anger namnet på IDataParameter.
SourceColumn

Hämtar eller anger namnet på källkolumnen som mappas till DataSet och används för att läsa in eller returnera Value.
SourceVersion

Hämtar eller ställer in som DataRowVersion ska användas vid inläsning Valueav .
Value

Hämtar eller anger värdet för parametern.

Gäller för