System.Data.SqlClient.SqlParameter.cs

#region 程序集 System.Data, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089
// C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.6.1\System.Data.dll
#endregion

using System.ComponentModel;
using System.Data.Common;
using System.Data.SqlTypes;

namespace System.Data.SqlClient
{
    //
    // 摘要:
    //     表示 System.Data.SqlClient.SqlCommand 的参数，或者其与 System.Data.DataSet 列的映射。 此类不能被继承。
    //     有关参数的详细信息，请参阅 配置参数和参数数据类型。
    [TypeConverter(typeof(SqlParameterConverter))]
    public sealed class SqlParameter : DbParameter, IDbDataParameter, IDataParameter, ICloneable
    {
        //
        // 摘要:
        //     初始化 System.Data.SqlClient.SqlParameter 类的新实例。
        public SqlParameter();
        //
        // 摘要:
        //     使用提供的参数名称和数据类型初始化 System.Data.SqlClient.SqlParameter 类的新实例。
        //
        // 参数:
        //   parameterName:
        //     要映射的参数的名称。
        //
        //   dbType:
        //     System.Data.SqlDbType 值之一。
        //
        // 异常:
        //   T:System.ArgumentException:
        //     参数 dbType 中提供的值不是有效的后端数据类型。
        public SqlParameter(string parameterName, SqlDbType dbType);
        //
        // 摘要:
        //     初始化 System.Data.SqlClient.SqlParameter 类的新实例，该类使用参数名称和新 System.Data.SqlClient.SqlParameter
        //     的值。
        //
        // 参数:
        //   parameterName:
        //     要映射的参数的名称。
        //
        //   value:
        //     作为 System.Object 的值的 System.Data.SqlClient.SqlParameter。
        public SqlParameter(string parameterName, object value);
        //
        // 摘要:
        //     使用参数名称、System.Data.SqlDbType 和大小初始化 System.Data.SqlClient.SqlParameter 类的新实例。
        //
        // 参数:
        //   parameterName:
        //     要映射的参数的名称。
        //
        //   dbType:
        //     System.Data.SqlDbType 值之一。
        //
        //   size:
        //     参数的长度。
        //
        // 异常:
        //   T:System.ArgumentException:
        //     参数 dbType 中提供的值不是有效的后端数据类型。
        public SqlParameter(string parameterName, SqlDbType dbType, int size);
        //
        // 摘要:
        //     使用提供的参数名称、System.Data.SqlDbType、大小和源列名初始化 System.Data.SqlClient.SqlParameter
        //     类的新实例。
        //
        // 参数:
        //   parameterName:
        //     要映射的参数的名称。
        //
        //   dbType:
        //     System.Data.SqlDbType 值之一。
        //
        //   size:
        //     参数的长度。
        //
        //   sourceColumn:
        //     源列名 (System.Data.SqlClient.SqlParameter.SourceColumn)（如果在调用 Overload:System.Data.Common.DbDataAdapter.Update
        //     中使用了此 System.Data.SqlClient.SqlParameter）。
        //
        // 异常:
        //   T:System.ArgumentException:
        //     参数 dbType 中提供的值不是有效的后端数据类型。
        public SqlParameter(string parameterName, SqlDbType dbType, int size, string sourceColumn);
        //
        // 摘要:
        //     使用提供的参数名称、参数类型、参数大小、System.Data.ParameterDirection、参数精度、参数小数位数、源列、要使用的 System.Data.DataRowVersion
        //     以及参数值初始化 System.Data.SqlClient.SqlParameter 类的新实例。
        //
        // 参数:
        //   parameterName:
        //     要映射的参数的名称。
        //
        //   dbType:
        //     System.Data.SqlDbType 值之一。
        //
        //   size:
        //     参数的长度。
        //
        //   direction:
        //     System.Data.ParameterDirection 值之一。
        //
        //   isNullable:
        //     如果字段的值可以为 null，则为 true；否则为 false。
        //
        //   precision:
        //     所解析的 System.Data.SqlClient.SqlParameter.Value 的小数点左右两侧的总位数。
        //
        //   scale:
        //     所解析的 System.Data.SqlClient.SqlParameter.Value 的总小数位数。
        //
        //   sourceColumn:
        //     源列名 (System.Data.SqlClient.SqlParameter.SourceColumn)（如果在调用 Overload:System.Data.Common.DbDataAdapter.Update
        //     中使用了此 System.Data.SqlClient.SqlParameter）。
        //
        //   sourceVersion:
        //     System.Data.DataRowVersion 值之一。
        //
        //   value:
        //     作为 System.Object 的值的 System.Data.SqlClient.SqlParameter。
        //
        // 异常:
        //   T:System.ArgumentException:
        //     参数 dbType 中提供的值不是有效的后端数据类型。
        [EditorBrowsable(EditorBrowsableState.Advanced)]
        public SqlParameter(string parameterName, SqlDbType dbType, int size, ParameterDirection direction, bool isNullable, byte precision, byte scale, string sourceColumn, DataRowVersion sourceVersion, object value);
        //
        // 摘要:
        //     使用以下信息初始化 System.Data.SqlClient.SqlParameter 类的新实例：参数名、参数类型、参数长度、参数传递方向、参数精度、参数的范围、源列名、System.Data.DataRowVersion
        //     的一个值、源列映射的布尔值、SqlParameter 的值、此 XML 实例的架构集所在的数据库名称、此 XML 实例的架构集所在的关系型架构，以及此参数的架构集的名称。
        //
        // 参数:
        //   parameterName:
        //     要映射的参数的名称。
        //
        //   dbType:
        //     System.Data.SqlDbType 值之一。
        //
        //   size:
        //     参数的长度。
        //
        //   direction:
        //     System.Data.ParameterDirection 值之一。
        //
        //   precision:
        //     所解析的 System.Data.SqlClient.SqlParameter.Value 的小数点左右两侧的总位数。
        //
        //   scale:
        //     所解析的 System.Data.SqlClient.SqlParameter.Value 的总小数位数。
        //
        //   sourceColumn:
        //     源列名 (System.Data.SqlClient.SqlParameter.SourceColumn)（如果在调用 Overload:System.Data.Common.DbDataAdapter.Update
        //     中使用了此 System.Data.SqlClient.SqlParameter）。
        //
        //   sourceVersion:
        //     System.Data.DataRowVersion 值之一。
        //
        //   sourceColumnNullMapping:
        //     如果源列可以为 null，则为 true；否则为 false。
        //
        //   value:
        //     作为 System.Object 的值的 System.Data.SqlClient.SqlParameter。
        //
        //   xmlSchemaCollectionDatabase:
        //     此 XML 实例的架构集合所在的数据库的名称。
        //
        //   xmlSchemaCollectionOwningSchema:
        //     此 XML 实例的架构集合所在的所属关系架构。
        //
        //   xmlSchemaCollectionName:
        //     此参数的架构集的名称。
        public SqlParameter(string parameterName, SqlDbType dbType, int size, ParameterDirection direction, byte precision, byte scale, string sourceColumn, DataRowVersion sourceVersion, bool sourceColumnNullMapping, object value, string xmlSchemaCollectionDatabase, string xmlSchemaCollectionOwningSchema, string xmlSchemaCollectionName);

        //
        // 摘要:
        //     获取或设置作为 SQL 类型的参数的值。
        //
        // 返回结果:
        //     System.Object 对象，是使用 SQL 类型的参数的值。 默认值为 null。
        [Browsable(false)]
        [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
        public object SqlValue { get; set; }
        //
        // 摘要:
        //     获取或设置作为参数的表示用户定义类型的 string。
        //
        // 返回结果:
        //     表示数据库中用户定义类型的完全限定名称的 string。
        [Browsable(false)]
        [EditorBrowsable(EditorBrowsableState.Advanced)]
        public string UdtTypeName { get; set; }
        //
        // 摘要:
        //     获取或设置表值参数的类型名称。
        //
        // 返回结果:
        //     指定的表值参数的类型名称。
        [Browsable(false)]
        [EditorBrowsable(EditorBrowsableState.Advanced)]
        public string TypeName { get; set; }
        //
        // 摘要:
        //     获取或设置参数的值。
        //
        // 返回结果:
        //     充当参数值的 System.Object。 默认值为 null。
        [RefreshProperties(RefreshProperties.All)]
        [ResCategoryAttribute("DataCategory_Data")]
        [ResDescriptionAttribute("DbParameter_Value")]
        [TypeConverter(typeof(StringConverter))]
        public override object Value { get; set; }
        //
        // 摘要:
        //     获取或设置列中的数据的最大大小（以字节为单位）。
        //
        // 返回结果:
        //     列中的数据的最大大小（以字节为单位）。 默认值将根据参数值进行推断。
        [ResCategoryAttribute("DataCategory_Data")]
        [ResDescriptionAttribute("DbParameter_Size")]
        public override int Size { get; set; }
        //
        // 摘要:
        //     获取或设置一个值，该值指示参数是否接受 null 值。 System.Data.SqlClient.SqlParameter.IsNullable 不用于验证参数的值，并且在执行命令时不会阻止发送或接收
        //     null 值。
        //
        // 返回结果:
        //     如果接受 null 值，则为 true；否则为 false。 默认值为 false。
        public override bool IsNullable { get; set; }
        //
        // 摘要:
        //     获取或设置 System.Data.SqlClient.SqlParameter.Value 属性的偏移量。
        //
        // 返回结果:
        //     System.Data.SqlClient.SqlParameter.Value 的偏移量。 默认值为 0。
        [Browsable(false)]
        [EditorBrowsable(EditorBrowsableState.Advanced)]
        [ResCategoryAttribute("DataCategory_Data")]
        [ResDescriptionAttribute("DbParameter_Offset")]
        public int Offset { get; set; }
        //
        // 摘要:
        //     获取或设置参数的 System.Data.SqlDbType。
        //
        // 返回结果:
        //     System.Data.SqlDbType 值之一。 默认值为 NVarChar。
        [DbProviderSpecificTypeProperty(true)]
        [RefreshProperties(RefreshProperties.All)]
        [ResCategoryAttribute("DataCategory_Data")]
        [ResDescriptionAttribute("SqlParameter_SqlDbType")]
        public SqlDbType SqlDbType { get; set; }
        //
        // 摘要:
        //     获取或设置映射到 System.Data.DataSet 并且用于加载或返回 System.Data.SqlClient.SqlParameter.Value
        //     的源列的名称
        //
        // 返回结果:
        //     映射到 System.Data.DataSet 的源列的名称。 默认值为一个空字符串。
        [ResCategoryAttribute("DataCategory_Update")]
        [ResDescriptionAttribute("DbParameter_SourceColumn")]
        public override string SourceColumn { get; set; }
        //
        // 摘要:
        //     获取或设置一个值，该值指示参数是只可输入的参数、只可输出的参数、双向参数还是存储过程返回值参数。
        //
        // 返回结果:
        //     System.Data.ParameterDirection 值之一。 默认值为 Input。
        //
        // 异常:
        //   T:System.ArgumentException:
        //     属性未设置为有效的 System.Data.ParameterDirection 值之一。
        [RefreshProperties(RefreshProperties.All)]
        [ResCategoryAttribute("DataCategory_Data")]
        [ResDescriptionAttribute("DbParameter_Direction")]
        public override ParameterDirection Direction { get; set; }
        //
        // 摘要:
        //     获取或设置所解析的 System.Data.SqlClient.SqlParameter.Value 的小数位数。
        //
        // 返回结果:
        //     所解析的 System.Data.SqlClient.SqlParameter.Value 的小数位数。 默认值为 0。
        [DefaultValue(0)]
        [ResCategoryAttribute("DataCategory_Data")]
        [ResDescriptionAttribute("DbDataParameter_Scale")]
        public byte Scale { get; set; }
        //
        // 摘要:
        //     获取或设置参数的 System.Data.SqlDbType。
        //
        // 返回结果:
        //     System.Data.SqlDbType 值之一。 默认值为 NVarChar。
        public override DbType DbType { get; set; }
        //
        // 摘要:
        //     获取或设置 System.Data.SqlClient.SqlParameter 的名称。
        //
        // 返回结果:
        //     System.Data.SqlClient.SqlParameter 的名称。 默认值为一个空字符串。
        [ResCategoryAttribute("DataCategory_Data")]
        [ResDescriptionAttribute("SqlParameter_ParameterName")]
        public override string ParameterName { get; set; }
        //
        // 摘要:
        //     获取或设置确定某一特定区域的约定和语言设置的区域设置标识符。
        //
        // 返回结果:
        //     返回与此参数相关联的区域设置标识符。
        [Browsable(false)]
        public int LocaleId { get; set; }
        //
        // 摘要:
        //     设置或获取一个值，该值指示源列是否可以为 null。 通过此操作，System.Data.SqlClient.SqlCommandBuilder 能够为可以为
        //     null 的列正确地生成 Update 语句。
        //
        // 返回结果:
        //     如果源列可以为 null，则为 true；否则为 false。
        public override bool SourceColumnNullMapping { get; set; }
        //
        // 摘要:
        //     实施时使用的参数的加密 Always Encrypted。 如果 SQL Server 通知驱动程序参数不需要进行加密，则使用该参数的查询会失败。 此属性针对安全攻击提供附加保护，这些安全攻击涉及向客户端提供不正确的加密元数据的受威胁的
        //     SQL Server，可能导致数据泄露。
        //
        // 返回结果:
        //     如果参数具有强制列加密，则为 true；否则为 false。
        [DefaultValue(false)]
        [ResCategoryAttribute("DataCategory_Data")]
        [ResDescriptionAttribute("TCE_SqlParameter_ForceColumnEncryption")]
        public bool ForceColumnEncryption { get; set; }
        //
        // 摘要:
        //     获取此 XML 实例的架构集合的名称。
        //
        // 返回结果:
        //     此 XML 实例的架构集合的名称。
        [ResCategoryAttribute("DataCategory_Xml")]
        [ResDescriptionAttribute("SqlParameter_XmlSchemaCollectionName")]
        public string XmlSchemaCollectionName { get; set; }
        //
        // 摘要:
        //     此 XML 实例的架构集合所在的所属关系架构。
        //
        // 返回结果:
        //     此 XML 实例的所属关系架构。
        [ResCategoryAttribute("DataCategory_Xml")]
        [ResDescriptionAttribute("SqlParameter_XmlSchemaCollectionOwningSchema")]
        public string XmlSchemaCollectionOwningSchema { get; set; }
        //
        // 摘要:
        //     获取此 XML 实例的架构集合所在的数据库的名称。
        //
        // 返回结果:
        //     此 XML 实例的架构集合所在的数据库的名称。
        [ResCategoryAttribute("DataCategory_Xml")]
        [ResDescriptionAttribute("SqlParameter_XmlSchemaCollectionDatabase")]
        public string XmlSchemaCollectionDatabase { get; set; }
        //
        // 摘要:
        //     获取或设置 System.Globalization.CompareInfo 对象，它定义应如何对此参数执行字符串比较。
        //
        // 返回结果:
        //     System.Globalization.CompareInfo 对象，它定义此参数的字符串比较。
        [Browsable(false)]
        public SqlCompareOptions CompareInfo { get; set; }
        //
        // 摘要:
        //     获取或设置用于表示 System.Data.SqlClient.SqlParameter.Value 属性的最大位数。
        //
        // 返回结果:
        //     用于表示 System.Data.SqlClient.SqlParameter.Value 属性的最大位数。 默认值为 0。 这指示数据提供程序将设置 System.Data.SqlClient.SqlParameter.Value
        //     的精度。
        [DefaultValue(0)]
        [ResCategoryAttribute("DataCategory_Data")]
        [ResDescriptionAttribute("DbDataParameter_Precision")]
        public byte Precision { get; set; }
        //
        // 摘要:
        //     获取或设置要在加载 System.Data.DataRowVersion 时使用的 System.Data.SqlClient.SqlParameter.Value。
        //
        // 返回结果:
        //     System.Data.DataRowVersion 值之一。 默认值为 Current。
        [ResCategoryAttribute("DataCategory_Update")]
        [ResDescriptionAttribute("DbParameter_SourceVersion")]
        public override DataRowVersion SourceVersion { get; set; }

        //
        // 摘要:
        //     重置与此 System.Data.SqlClient.SqlParameter 关联的类型。
        public override void ResetDbType();
        //
        // 摘要:
        //     重置与此 System.Data.SqlClient.SqlParameter 关联的类型。
        public void ResetSqlDbType();
        //
        // 摘要:
        //     获取一个包含 System.Data.SqlClient.SqlParameter.ParameterName 的字符串。
        //
        // 返回结果:
        //     一个包含 System.Data.SqlClient.SqlParameter.ParameterName 的字符串。
        public override string ToString();
    }
}