SqlParameter Clase

Definición

Representa un parámetro para un elemento SqlCommand y, de forma opcional, su asignación a columnas DataSet.Represents a parameter to a SqlCommand and optionally its mapping to DataSet columns. Esta clase no puede heredarse.This class cannot be inherited. Para más información sobre los parámetros, vea Configurar parámetros y tipos de datos de parámetros.For more information on parameters, see Configuring Parameters and Parameter Data Types.

public ref class SqlParameter sealed : System::Data::Common::DbParameter, ICloneable
[System.ComponentModel.TypeConverter("System.Data.SqlClient.SqlParameter+SqlParameterConverter, System.Data, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")]
[System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameterConverter))]
[System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameter/SqlParameterConverter))]
[System.ComponentModel.TypeConverter("System.Data.SqlClient.SqlParameter+SqlParameterConverter, System.Data, Version=2.0.5.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")]
public sealed class SqlParameter : System.Data.Common.DbParameter, ICloneable
type SqlParameter = class
    inherit DbParameter
    interface IDbDataParameter
    interface IDataParameter
    interface ICloneable
Public NotInheritable Class SqlParameter
Inherits DbParameter
Implements ICloneable
Herencia
SqlParameter
Atributos
Implementaciones

Ejemplos

En el ejemplo siguiente se crean varias instancias de SqlParameter a través de la colección SqlParameterCollection dentro de la SqlDataAdapter.The following example creates multiple instances of 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 el DataSet.These parameters are used to select data from the data source and put the data in the DataSet. En este ejemplo se da por supuesto que ya se ha creado un DataSet y un SqlDataAdapter mediante el esquema, los comandos y la conexión adecuados.This example assumes that a DataSet and a SqlDataAdapter have already been created by using the appropriate schema, commands, and connection. Para obtener más información y ejemplos adicionales sobre el uso de parámetros, vea recuperar y modificar datos en ADO.net y Configurar parámetros y tipos de datosde parámetros.For more information and additional examples on using parameters, see Retrieving and Modifying Data in ADO.NET and Configuring Parameters and Parameter Data Types.

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

En los nombres de parámetros no se distinguen mayúsculas de minúsculas.Parameter names are not case sensitive.

Nota

El proveedor de datos de .NET Framework para SQL Server no admite los parámetros con nombre, también denominados ordinales.Nameless, also called ordinal, parameters are not supported by the .NET Framework Data Provider for SQL Server.

Para obtener más información, junto con código de ejemplo adicional en el que se muestra cómo usar los parámetros, vea comandos y parámetros.For more information, along with additional sample code demonstrating how to use parameters, see Commands and Parameters.

Constructores

SqlParameter()

Inicializa una nueva instancia de la clase SqlParameter.Initializes a new instance of the SqlParameter class.

SqlParameter(String, Object)

Inicializa una nueva instancia de la clase SqlParameter que usa el nombre de parámetro y un valor del nuevo elemento SqlParameter.Initializes a new instance of the SqlParameter class that uses the parameter name and a value of the new SqlParameter.

SqlParameter(String, SqlDbType)

Inicializa una nueva instancia de la clase SqlParameter que usa el nombre de parámetro y el tipo de datos.Initializes a new instance of the SqlParameter class that uses the parameter name and the data type.

SqlParameter(String, SqlDbType, Int32)

Inicializa una nueva instancia de la clase SqlParameter que usa el nombre del parámetro, el SqlDbType y el tamaño.Initializes a new instance of the SqlParameter class that uses the parameter name, the SqlDbType, and the size.

SqlParameter(String, SqlDbType, Int32, ParameterDirection, Boolean, Byte, Byte, String, DataRowVersion, Object)

Inicializa una nueva instancia de la clase SqlParameter que usa el nombre, el tipo y el tamaño del parámetro, una ParameterDirection, l precisión y la escala del parámetro, la columna de origen, una DataRowVersion que se usará y el valor del parámetro.Initializes a new instance of the SqlParameter class that uses the parameter name, the type of the parameter, the size of the parameter, a ParameterDirection, the precision of the parameter, the scale of the parameter, the source column, a DataRowVersion to use, and the value of the parameter.

SqlParameter(String, SqlDbType, Int32, String)

Inicializa una nueva instancia de la clase SqlParameter que usa el nombre del parámetro, el SqlDbType, el tamaño y el nombre de la columna de origen.Initializes a new instance of the SqlParameter class that uses the parameter name, the SqlDbType, the size, and the source column name.

SqlParameter(String, SqlDbType, String, String, String, Int32, ParameterDirection, Byte, Byte, String, DataRowVersion, Boolean, Object)

Inicializa una nueva instancia de la clase SqlParameter que usa el nombre del parámetro, el tipo del parámetro, la longitud del parámetro, la dirección, la precisión, la escala, el nombre de la columna de origen, uno de los valores de DataRowVersion, un valor booleano para la asignación de la columna de origen, el valor de SqlParameter, el nombre de la base de datos donde se encuentra la colección de esquemas para esta instancia XML, el esquema relacional propietario donde se encuentra la colección de esquemas para esta instancia XML y el nombre de la colección de esquemas para este parámetro.Initializes a new instance of the SqlParameter class that uses the parameter name, the type of the parameter, the length of the parameter the direction, the precision, the scale, the name of the source column, one of the DataRowVersion values, a Boolean for source column mapping, the value of the SqlParameter, the name of the database where the schema collection for this XML instance is located, the owning relational schema where the schema collection for this XML instance is located, and the name of the schema collection for this parameter.

Propiedades

CompareInfo

Obtiene o establece el objeto CompareInfo que define cómo se deben realizar las comparaciones de cadenas para este parámetro.Gets or sets the CompareInfo object that defines how string comparisons should be performed for this parameter.

DbType

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

Direction

Obtiene o establece un valor que indica si el parámetro es sólo de entrada, sólo de salida, bidireccional, o un valor devuelto de un procedimiento almacenado.Gets or sets a value that indicates whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.

ForceColumnEncryption

Aplica el cifrado de un parámetro al usar Always Encrypted.Enforces encryption of a parameter when using Always Encrypted. Si SQL Server informa al controlador de que el parámetro no tiene que estar cifrado, se producirá un error en la consulta que usa el parámetro.If SQL Server informs the driver that the parameter does not need to be encrypted, the query using the parameter will fail. Esta propiedad ofrece protección adicional contra los ataques de seguridad que implican un SQL Server en peligro al proporcionar metadatos de cifrado incorrectos al cliente, lo que puede provocar la divulgación de los datos.This property provides additional protection against security attacks that involve a compromised SQL Server providing incorrect encryption metadata to the client, which may lead to data disclosure.

IsNullable

Obtiene o establece un valor que indica si el parámetro acepta valores null.Gets or sets a value that indicates whether the parameter accepts null values. IsNullable no se usa para validar el valor del parámetro ni evita el envío o la recepción de un valor null al ejecutar un comando.IsNullable is not used to validate the parameter's value and will not prevent sending or receiving a null value when executing a command.

LocaleId

Obtiene o establece el identificador de configuración regional que determina las convenciones y el idioma de una región determinada.Gets or sets the locale identifier that determines conventions and language for a particular region.

Offset

Obtiene o establece el desplazamiento hasta la propiedad Value.Gets or sets the offset to the Value property.

ParameterName

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

Precision

Obtiene o establece el número máximo de dígitos que se usan para representar la propiedad Value.Gets or sets the maximum number of digits used to represent the Value property.

Scale

Obtiene o establece el número de posiciones decimales con que se resuelve Value.Gets or sets the number of decimal places to which Value is resolved.

Size

Obtiene o establece el tamaño máximo, en bytes, de los datos de la columna.Gets or sets the maximum size, in bytes, of the data within the column.

SourceColumn

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

SourceColumnNullMapping

Establece u obtiene un valor que indica si la columna de origen acepta valores null.Sets or gets a value which indicates whether the source column is nullable. Esto permite a SqlCommandBuilder generar correctamente instrucciones Update para las columnas que aceptan valores NULL.This allows SqlCommandBuilder to correctly generate Update statements for nullable columns.

SourceVersion

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

SqlDbType

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

SqlValue

Obtiene o establece el valor del parámetro como tipo SQL.Gets or sets the value of the parameter as an SQL type.

TypeName

Obtiene o establece el nombre de tipo para un parámetro con valores de tabla.Gets or sets the type name for a table-valued parameter.

UdtTypeName

Obtiene o establece un string que representa un tipo definido por el usuario como un parámetro.Gets or sets a string that represents a user-defined type as a parameter.

Value

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

XmlSchemaCollectionDatabase

Obtiene el nombre de la base de datos donde se encuentra la colección de esquemas para esta instancia XML.Gets the name of the database where the schema collection for this XML instance is located.

XmlSchemaCollectionName

Obtiene el nombre de la colección de esquemas para esta instancia XML.Gets the name of the schema collection for this XML instance.

XmlSchemaCollectionOwningSchema

Esquema relacional propietario donde se encuentra la colección de esquemas para esta instancia XML.The owning relational schema where the schema collection for this XML instance is located.

Métodos

CreateObjRef(Type)

Crea un objeto que contiene toda la información relevante necesaria para generar un proxy utilizado para comunicarse con un objeto remoto.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Heredado de MarshalByRefObject)
Equals(Object)

Determina si el objeto especificado es igual al objeto actual.Determines whether the specified object is equal to the current object.

(Heredado de Object)
GetHashCode()

Sirve como función hash predeterminada.Serves as the default hash function.

(Heredado de Object)
GetLifetimeService()

Recupera el objeto de servicio de duración actual que controla la directiva de duración de esta instancia.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Heredado de MarshalByRefObject)
GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Heredado de Object)
InitializeLifetimeService()

Obtiene un objeto de servicio de duración para controlar la directiva de duración de esta instancia.Obtains a lifetime service object to control the lifetime policy for this instance.

(Heredado de MarshalByRefObject)
MemberwiseClone()

Crea una copia superficial del Object actual.Creates a shallow copy of the current Object.

(Heredado de Object)
MemberwiseClone(Boolean)

Crea una copia superficial del objeto MarshalByRefObject actual.Creates a shallow copy of the current MarshalByRefObject object.

(Heredado de MarshalByRefObject)
ResetDbType()

Restablece el tipo asociado a este SqlParameter.Resets the type associated with this SqlParameter.

ResetSqlDbType()

Restablece el tipo asociado a este SqlParameter.Resets the type associated with this SqlParameter.

ToString()

Obtiene una cadena que contiene la propiedad ParameterName.Gets a string that contains the ParameterName.

Implementaciones de interfaz explícitas

ICloneable.Clone()

Para una descripción de este miembro, vea Clone().For a description of this member, see Clone().

Se aplica a

Consulte también: