IDataParameter IDataParameter IDataParameter IDataParameter Interface

Definición

Representa un parámetro para un objeto Command y, opcionalmente, sus asignaciones a columnas DataSet; además, se implementa mediante proveedores de datos .NET Framework que acceden a orígenes de datos.Represents a parameter to a Command object, and optionally, its mapping to DataSet columns; and is implemented by .NET Framework data providers that access data sources.

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 SqlParameterderivada,, SqlParameterCollection a través de SqlDataAdapterla colección dentro de.The following example creates multiple instances of the derived class, SqlParameter, through the SqlParameterCollection collection within the SqlDataAdapter. Estos parámetros se utilizan para seleccionar datos del origen de datos y colocar los datos en DataSet.These parameters are used to select data from the data source and place the data in the DataSet. En este ejemplo se da DataSet por supuesto SqlDataAdapter que ya se han creado un y un con el esquema, los comandos y la conexión adecuados.This example assumes that a DataSet and a SqlDataAdapter have already been created with the appropriate schema, commands, and connection.

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 a una clase heredada implementar una clase de parámetro, que representa un parámetro de un objeto Command.The IDataParameter interface allows an inheriting class to implement a Parameter class, which represents a parameter to a Command object. Para obtener más información sobre las clases de parámetros, vea Configurar parámetros y tipos de datos de parámetros.For more information about Parameter classes, see 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 IDataParameterhereda.An application does not create an instance of the IDataParameter interface directly, but creates an instance of a class that inherits IDataParameter.

Las clases que IDataParameter heredan deben implementar los miembros heredados y, normalmente, definir miembros adicionales para agregar funcionalidad específica del proveedor.Classes that inherit IDataParameter must implement the inherited members, and typically define additional members to add provider-specific functionality. Por ejemplo, la IDataParameter interfaz define la DbType propiedad.For example, the IDataParameter interface defines the DbType property. A su vez, OleDbParameter la clase hereda esta propiedad y también define la OleDbType propiedad.In turn, the OleDbParameter class inherits this property, and also defines the OleDbType property.

Notas a los implementadores

Para promover la coherencia entre .NET Framework proveedores de datos, asigne un nombre a la clase Prv heredada Prv en el parámetro de formulario, donde es el prefijo uniforme dado a todas las clases de un espacio de nombres de proveedor de datos .NET Framework específico.To promote consistency among .NET Framework data providers, name the inheriting class in the form Prv Parameter where Prv is the uniform prefix given to all classes in a specific .NET Framework data provider namespace. Por ejemplo, Sql es el prefijo de SqlCommand la clase en System.Data.SqlClient el espacio de nombres.For example, Sql is the prefix of the SqlCommand class in the System.Data.SqlClient namespace.

Al heredar de la IDataParameter interfaz, debe implementar los siguientes constructores:When you inherit from the IDataParameter interface, you should implement the following constructors:

ElementoItem DescripciónDescription
PrvParameter()PrvParameter() Inicializa una nueva instancia de la clase de parámetro.Initializes a new instance of the Parameter class.

PrvParameter (nombre de cadena, tipo de valor de PrvDbType)PrvParameter(string name, PrvDbType dataType) Inicializa una nueva instancia de la clase Parameter con el nombre de parámetro y el tipo de datos.Initializes a new instance of the Parameter class with the parameter name and data type.

PrvParameter (nombre de cadena, valor de objeto)PrvParameter(string name, object value) Inicializa una nueva instancia de la clase Parameter con el nombre de parámetro y un objeto que es el valor del parámetro.Initializes a new instance of the Parameter class with the parameter name and an object that is the value of the Parameter.

PrvParameter (nombre de cadena, tipo de valor de PrvDbType, int size)PrvParameter(string name, PrvDbType dataType, int size) Inicializa una nueva instancia de la clase Parameter con el nombre de parámetro, el tipo de datos y el ancho.Initializes a new instance of the Parameter class with the parameter name, data type, and width.

PrvParameter (nombre de cadena, tipo de valor de PrvDbType, int size, String srcColumn)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 la columna de origen.Initializes a new instance of the DbParameter class with the parameter name, data type, width, and source column name.

PrvParameter (cadena parameterName, PrvDbType dbType, tamaño int, dirección ParameterDirection, booleano isNullable, precisión de bytes, escala de bytes, cadena srcColumn, DataRowVersion srcVersion, valor del objeto)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 de parámetro, el tipo de datos, el ancho, el nombre de la columna de origen, la dirección del parámetro, la precisión numérica y otras propiedades.Initializes a new instance of the OleDbParameter class with the parameter name, data type, width, source column name, parameter direction, numeric precision, and other properties.

Propiedades

DbType DbType DbType DbType

Obtiene o establece el DbType del parámetro.Gets or sets the DbType of the parameter.

Direction Direction Direction 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.Gets or sets a value indicating whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.

IsNullable IsNullable IsNullable IsNullable

Obtiene un valor que indica si el parámetro acepta valores null.Gets a value indicating whether the parameter accepts null values.

ParameterName ParameterName ParameterName ParameterName

Obtiene o establece el nombre de IDataParameter.Gets or sets the name of the IDataParameter.

SourceColumn SourceColumn SourceColumn SourceColumn

Obtiene o establece el nombre de la columna de origen asignada a DataSet y que se usa para cargar o devolver Value.Gets or sets the name of the source column that is mapped to the DataSet and used for loading or returning the Value.

SourceVersion SourceVersion SourceVersion SourceVersion

Obtiene o establece DataRowVersion que se va a utilizar al cargar Value.Gets or sets the DataRowVersion to use when loading Value.

Value Value Value Value

Obtiene o establece el valor del parámetro.Gets or sets the value of the parameter.

Se aplica a