SqlParameter Clase

Definición

Representa un parámetro para un elemento SqlCommand y, de forma opcional, su asignación a columnas DataSet. Esta clase no puede heredarse. Para obtener más información sobre los parámetros, consulte Configuración de parámetros.

public ref class SqlParameter sealed : System::Data::Common::DbParameter, ICloneable
[System.ComponentModel.TypeConverter(typeof(Microsoft.Data.SqlClient.SqlParameter+SqlParameterConverter))]
public sealed class SqlParameter : System.Data.Common.DbParameter, ICloneable
public sealed class SqlParameter : System.Data.Common.DbParameter, ICloneable
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Data.SqlClient.SqlParameter+SqlParameterConverter))>]
type SqlParameter = class
    inherit DbParameter
    interface IDbDataParameter
    interface IDataParameter
    interface ICloneable
type SqlParameter = class
    inherit DbParameter
    interface IDataParameter
    interface IDbDataParameter
    interface ICloneable
Public NotInheritable Class SqlParameter
Inherits DbParameter
Implements ICloneable
Herencia
SqlParameter
Atributos
Implementaciones

Ejemplos

En el ejemplo siguiente se crean varias instancias de a través de SqlParameter 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 y SqlDataAdapter mediante el esquema, los comandos y la conexión adecuados. Para obtener más información y ejemplos adicionales sobre el uso de parámetros, consulte Recuperación y modificación de datos en ADO.NET y Configuración de parámetros.

using Microsoft.Data.SqlClient;
using System.Xml;
using System.Data.Common;
using System.Windows.Forms;

public class Form1 : Form
{
    protected DataSet categoriesDataSet;
    protected DataGrid dataGrid1;
    protected SqlDataAdapter categoriesAdapter;


    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);

    }
}

Comentarios

En los nombres de parámetros no se distinguen mayúsculas de minúsculas.

Nota:

El proveedor de datos de .NET Framework no admite los parámetros, también denominados ordinales, para SQL Server.

Para obtener más información, junto con código de ejemplo adicional que muestra cómo usar parámetros, vea Comandos y parámetros.

Constructores

SqlParameter()

Inicializa una nueva instancia de la clase SqlParameter.

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.

SqlParameter(String, SqlDbType)

Inicializa una nueva instancia de la clase SqlParameter que usa el nombre de parámetro y el tipo de datos.

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.

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.

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

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.

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.

Propiedades

CompareInfo

Obtiene o establece el objeto CompareInfo que define cómo se deben realizar las comparaciones de cadenas para este parámetro.

DbType

Obtiene o establece el SqlDbType del parámetro.

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.

ForceColumnEncryption

Aplica el cifrado de un parámetro al usar Always Encrypted. Si SQL Server indica al controlador que no hace falta cifrar el parámetro, la consulta que utilice este último generará un error. Esta propiedad confiere una protección adicional frente a ataques contra la seguridad que utilice un servidor SQL Server comprometido que proporcione metadatos de cifrado incorrectos al cliente, lo cual podría provocar la divulgación de datos.

IsNullable

Obtiene o establece un valor que indica si el parámetro acepta valores null. 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.

LocaleId

Obtiene o establece el identificador de configuración regional que determina las convenciones y el idioma de una región determinada.

Offset

Obtiene o establece el desplazamiento hasta la propiedad Value.

ParameterName

Obtiene o establece el nombre de SqlParameter.

Precision

Obtiene o establece el número máximo de dígitos usados para representar la propiedad Value.

Scale

Obtiene o establece el número de posiciones decimales con que se resuelve Value.

Size

Obtiene o establece el tamaño máximo, en bytes, de los datos de la columna.

SourceColumn

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

SourceColumnNullMapping

Establece u obtiene un valor que indica si la columna de origen acepta valores null. Esto permite a SqlCommandBuilder generar correctamente instrucciones Update para las columnas que aceptan valores NULL.

SourceVersion

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

SqlDbType

Obtiene o establece el SqlDbType del parámetro.

SqlValue

Obtiene o establece el valor del parámetro como tipo SQL.

TypeName

Obtiene o establece el nombre de tipo para un parámetro con valores de tabla.

UdtTypeName

Obtiene o establece un string que representa un tipo definido por el usuario como un parámetro.

Value

Obtiene o establece el valor del parámetro.

XmlSchemaCollectionDatabase

Obtiene el nombre de la base de datos donde se encuentra la colección de esquemas para esta instancia XML.

XmlSchemaCollectionName

Obtiene el nombre de la colección de esquemas para esta instancia XML.

XmlSchemaCollectionOwningSchema

Esquema relacional propietario donde se encuentra la colección de esquemas para esta instancia XML.

Métodos

ResetDbType()

Restablece el tipo asociado a este SqlParameter.

ResetSqlDbType()

Restablece el tipo asociado a este SqlParameter.

ToString()

Obtiene una cadena que contiene la propiedad ParameterName.

Implementaciones de interfaz explícitas

ICloneable.Clone()

Para obtener una descripción de este miembro, vea Clone().

Se aplica a

Consulte también