IDataParameter Interfaz

  • Referencia

Definición

Espacio de nombres:
System.Data
Ensamblado:
System.Data.Common.dll
Ensamblado:
System.Data.dll
Ensamblado:
netstandard.dll

Representa un parámetro para un objeto Command y, opcionalmente, sus asignaciones a columnas DataSet; además, se implementa mediante proveedores de datos de .NET que acceden a orígenes de datos.

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

Ejemplos

En el ejemplo siguiente se crean varias instancias de la clase derivada, SqlParameter, a través de la SqlParameterCollection colección dentro de SqlDataAdapter. Estos parámetros se usan para seleccionar datos del origen de datos y colocar los datos en DataSet. En este ejemplo se supone que ya se ha creado un DataSet objeto y SqlDataAdapter con el esquema, los comandos y la conexión adecuados.

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

Comentarios

La IDataParameter interfaz permite que una clase heredada implemente una clase Parameter, que representa un parámetro para un objeto Command. Para obtener más información sobre las clases Parameter, vea Configuring Parameters and Parameter Data Types.

Una aplicación no crea una instancia de la IDataParameter interfaz directamente, sino que crea una instancia de una clase que hereda IDataParameter.

Las clases que heredan IDataParameter deben implementar los miembros heredados y normalmente definir miembros adicionales para agregar funcionalidad específica del proveedor. Por ejemplo, la IDataParameter interfaz define la DbType propiedad . A su vez, la OleDbParameter clase hereda esta propiedad y también define la OleDbType propiedad .

Notas a los implementadores

Para promover la coherencia entre los proveedores de datos de .NET Framework, asigne un nombre a la clase heredada en el formato Prv Parameter , donde Prv es el prefijo uniforme proporcionado a todas las clases de un espacio de nombres específico del proveedor de datos de .NET Framework. Por ejemplo, Sql es el prefijo de la SqlCommand clase en el System.Data.SqlClient espacio de nombres .

Al heredar de la IDataParameter interfaz, debe implementar los siguientes constructores:

Elemento Descripción
PrvParameter() Inicializa una nueva instancia de la clase Parameter.
PrvParameter(string name, PrvDbType dataType) Inicializa una nueva instancia de la clase Parameter con el nombre del parámetro y el tipo de datos.
PrvParameter(string name, object value) Inicializa una nueva instancia de la clase Parameter con el nombre del parámetro y un objeto que es el valor del parámetro.
PrvParameter(string name, PrvDbType dataType, int size) Inicializa una nueva instancia de la clase Parameter con el nombre del parámetro, el tipo de datos y el ancho.
PrvParameter(string name, PrvDbType dataType, int size, string srcColumn) Inicializa una nueva instancia de la clase DbParameter con el nombre del parámetro, el tipo de datos, el ancho y el nombre de columna de origen.
PrvParameter(string parameterName, PrvDbType dbType, int size, ParameterDirection direction, Boolean isNullable, Byte precision, Byte scale, string srcColumn, DataRowVersion srcVersion, object value) Inicializa una nueva instancia de la OleDbParameter clase con el nombre del parámetro, el tipo de datos, el ancho, el nombre de columna de origen, la dirección del parámetro, la precisión numérica y otras propiedades.

Propiedades

DbType

Obtiene o establece el DbType del parámetro.
Direction

Obtiene o establece un valor que indica si el parámetro es solo de entrada, solo de salida, bidireccional o un parámetro de valor devuelto de un procedimiento almacenado.
IsNullable

Obtiene un valor que indica si el parámetro acepta valores null.
ParameterName

Obtiene o establece el nombre de IDataParameter.
SourceColumn

Obtiene o establece el nombre de la columna de origen asignada a DataSet y que se usa para cargar o devolver Value.
SourceVersion

Obtiene o establece DataRowVersion que se va a utilizar al cargar Value.
Value

Obtiene o establece el valor del parámetro.

Se aplica a