IDataParameter Interfaccia

  • Riferimento

Definizione

Spazio dei nomi:
System.Data
Assembly:
System.Data.Common.dll
Assembly:
System.Data.dll
Assembly:
netstandard.dll

Rappresenta un parametro per un oggetto Command ed eventualmente il relativo mapping a colonne DataSet e viene implementata dai provider di dati .NET che accedono a database relazionali.

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 l'insieme SqlParameterCollection 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 eredita di implementare una classe Parameter, che rappresenta un parametro a un oggetto Command. Per altre informazioni sulle classi di parametri, vedere Configurazione dei parametri e dei tipi di dati dei parametri.

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

Le classi che ereditano devono implementare IDataParameter i membri ereditati e in genere definiscono altri membri 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, assegnare un nome alla classe ereditata nel parametro del modulo Prv in cui 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 System.Data.SqlClient spazio dei nomi.

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

Elemento Descrizione
PrvParameter() Inizializza una nuova istanza della classe Parameter.
PrvParameter(nome stringa, PrvDbType dataType) Inizializza una nuova istanza della classe Parameter con il nome del parametro e il tipo di dati.
PrvParameter(nome stringa, valore oggetto) Inizializza una nuova istanza della classe Parameter con il nome del parametro e un oggetto che rappresenta il valore del parametro Parameter.
PrvParameter(nome stringa, DataType PrvDbType, dimensioni int) Inizializza una nuova istanza della classe Parameter con il nome del parametro, il tipo di dati e la larghezza.
PrvParameter(nome stringa, PrvDbType dataType, dimensioni int, stringa 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, valore oggetto) 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 dei OleDbParameter parametri, la precisione numerica e altre proprietà.

Proprietà

DbType

Ottiene o imposta l'oggetto DbType del parametro.
Direction

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

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

Ottiene o imposta il nome di IDataParameter.
SourceColumn

Ottiene o imposta il nome della colonna di origine mappata a DataSet e usata per caricare o restituire Value.
SourceVersion

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

Ottiene o imposta il valore del parametro.

Si applica a