Condividi tramite

IDataParameter Interfaccia

Definizione

Spazio dei nomi:
System.Data
Assembly:
netstandard.dll, System.Data.Common.dll
Assembly:
System.Data.Common.dll
Assembly:
System.Data.dll
Assembly:
netstandard.dll
Origine:
IDataParameter.cs
Origine:
IDataParameter.cs

Rappresenta un parametro per un oggetto Command e, facoltativamente, il relativo mapping alle colonne e viene implementato dai provider di dati .NET che accedono alle DataSet origini dati.

public interface class IDataParameter
public interface IDataParameter
type IDataParameter = interface
Public Interface IDataParameter
Derivato

Esempio

Nell'esempio seguente vengono create più istanze della classe derivata, , SqlParametertramite la SqlParameterCollection raccolta all'interno di SqlDataAdapter. Questi parametri vengono usati per selezionare i dati dall'origine dati e inserire i dati in DataSet. In questo esempio si presuppone che un oggetto DataSet e sia SqlDataAdapter già stato creato con lo schema, i comandi e la connessione appropriati.

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

Commenti

L'interfaccia IDataParameter consente a una classe che eredita di implementare una classe Parameter, che rappresenta un parametro per un oggetto Command. Per altre informazioni sulle classi Parameter, vedere Configuring Parameters and Parameter Data Types.

Un'applicazione non crea direttamente un'istanza dell'interfaccia, ma crea un'istanza IDataParameter di una classe che eredita IDataParameter.

Le classi che ereditano IDataParameter devono implementare i membri ereditati e in genere definiscono membri aggiuntivi per aggiungere funzionalità specifiche del provider. Ad esempio, l'interfaccia IDataParameter definisce la DbType proprietà . A sua volta, la OleDbParameter classe eredita questa proprietà e definisce anche la OleDbType proprietà .

Note per gli implementatori

Per promuovere la coerenza tra i provider di dati .NET Framework, denominare la classe che eredita nel parametro del modulo Prv dove Prv è il prefisso uniforme assegnato a tutte le classi in uno spazio dei nomi specifico del provider di dati .NET Framework. Ad esempio, Sql è il prefisso della SqlCommand classe nello spazio dei System.Data.SqlClient nomi .

Quando si eredita dall'interfaccia IDataParameter , è necessario implementare i costruttori seguenti:

Elemento Descrizione
PrvParameter() Inizializza una nuova istanza della classe Parameter.
PrvParameter(string name, PrvDbType dataType) Inizializza una nuova istanza della classe Parameter con il nome del parametro e il tipo di dati.
PrvParameter(string name, object value) Inizializza una nuova istanza della classe Parameter con il nome del parametro e un oggetto che rappresenta il valore di Parameter.
PrvParameter(string name, PrvDbType dataType, int size) Inizializza una nuova istanza della classe Parameter con il nome del parametro, il tipo di dati e la larghezza.
PrvParameter(string name, PrvDbType dataType, int size, string srcColumn) Inizializza una nuova istanza della classe DbParameter con il nome del parametro, il tipo di dati, la larghezza e il nome della colonna di origine.
PrvParameter(string parameterName, PrvDbType dbType, int size, ParameterDirection direction, Boolean isNullable, Byte precision, Byte scale, string srcColumn, DataRowVersion srcVersion, object value) Inizializza una nuova istanza della classe con il nome del parametro, il tipo di dati, la larghezza, il nome della colonna di origine, la direzione del parametro, la OleDbParameter precisione numerica e altre proprietà.

Proprietà

Nome Descrizione
DbType

Ottiene o imposta l'oggetto DbType del parametro .
Direction

Ottiene o imposta un valore che indica se il parametro è solo input, solo output, bidirezionale o un parametro del valore restituito della stored procedure.
IsNullable

Ottiene un valore che indica se il parametro accetta valori Null.
ParameterName

Ottiene o imposta il nome dell'oggetto IDataParameter.
SourceColumn

Ottiene o imposta il nome della colonna di origine mappata a DataSet e utilizzata per il caricamento o la restituzione dell'oggetto Value.
SourceVersion

Ottiene o imposta l'oggetto da utilizzare durante il DataRowVersion caricamento di Value.
Value

Ottiene o imposta il valore del parametro.

Si applica a