Partager via


DataParameter Class

Represents a data parameter that is derived from a data source command, or that is passed with a command to a data source.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Data.DataParameter
    Microsoft.VisualStudio.Data.AdoDotNet.AdoDotNetParameter

Namespace:  Microsoft.VisualStudio.Data
Assembly:  Microsoft.VisualStudio.Data (in Microsoft.VisualStudio.Data.dll)

Syntax

'Déclaration
Public MustInherit Class DataParameter
public abstract class DataParameter
public ref class DataParameter abstract
[<AbstractClass>]
type DataParameter =  class end
public abstract class DataParameter

The DataParameter type exposes the following members.

Constructors

  Name Description
Protected method DataParameter() Class constructor. Initializes a nonparameterized instance of the DataParameter class.
Protected method DataParameter(Boolean) Class constructor. Initializes a parameterized instance of the DataParameter class, along with an indication whether the instance was derived using the DeriveParameters method.

Top

Properties

  Name Description
Protected property DefaultPrecision Retrieves a byte value specifying the default precision for the current parameter type.
Protected property DefaultScale Retrieves a byte value specifying the default scale for the current parameter type.
Protected property DefaultSize Retrieves and integer value specifying the default size for the current parameter type.
Public property Direction Retrieves or sets a DataParameterDirection object specifying the direction of the parameter.
Public property IsDerived Retrieves a Boolean value that indicates whether this parameter was derived from the data source.
Protected property IsFixedPrecision Retrieves a Boolean value indicating whether the precision for the current parameter type is fixed.
Protected property IsFixedScale Retrieves a Boolean value indicating whether the scale for the current parameter type is fixed.
Protected property IsFixedSize Retrieves a Boolean value indicating whether the size for the current parameter type is fixed.
Public property IsNullable Retrieves a Boolean value indicating whether this parameter can have a nulla null reference (Nothing in Visual Basic) value.
Public property IsOptional Retrieves a Boolean value indicating whether this parameter is optional, in cases where this parameter is a derived parameter.
Public property Name Retrieves or sets the string literal name of the parameter.
Public property Precision Retrieves or sets a byte value specifying the precision of the parameter.
Public property Scale Retrieves or sets a byte value specifying the scale of the parameter.
Public property Size Retrieves or sets an integer value specifying the size of the parameter.
Public property Type Retrieves or sets the data-source-specific type of the parameter.
Public property Value Retrieves or sets the value of the parameter.

Top

Methods

  Name Description
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected method GetDirectionImpl Retrieves the parameter direction.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Protected method GetIsNullableImpl Retrieves a Boolean value indicating whether or not this parameter can be nulla null reference (Nothing in Visual Basic).
Protected method GetIsOptionalImpl Retrieves a Boolean value indicating whether this parameter is optional.
Protected method GetNameImpl Retrieves the name of the parameter.
Protected method GetPrecisionImpl Retrieves a byte value specifying the precision of the parameter.
Protected method GetScaleImpl Retrieves a byte value specifying the scale of the parameter.
Protected method GetSizeImpl Retrieves an integer value specifying the size of the parameter.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method GetTypeFrom Infers the data-source-specific parameter type from a parameter value.
Protected method GetTypeImpl Retrieves the data-source-specific type of the parameter.
Protected method GetValueImpl Retrieves the value of a specified parameter.
Protected method IsSupportedDirection Retrieves a Boolean value indicating whether the specified parameter direction is supported.
Protected method IsValidType Retrieves a Boolean value indicating whether the specified data-source-specific type is a valid type.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnDirectionChanged Called when the Direction property is changed to signal a change in the parameter direction.
Protected method OnDirectionChanging Called when the Direction property is about to change.
Protected method OnNameChanged Called when the Name property has changed.
Protected method OnNameChanging Called when the Name property is about to change.
Protected method OnPrecisionChanged Called when the Precision property has changed.
Protected method OnPrecisionChanging Called when the Precision property is about to change.
Protected method OnScaleChanged Called when the Scale property has changed.
Protected method OnScaleChanging Called when the Scale property is about to change.
Protected method OnSizeChanged Called when the Size property has changed.
Protected method OnSizeChanging Called when the Size property is about to change.
Protected method OnTypeChanged Called when the Type property has changed.
Protected method OnTypeChanging Called when the Type property is about to change.
Protected method OnValueChanged Called when the Value property has changed.
Protected method OnValueChanging Called when the Value property is about to change.
Public method Parse Disassembles a parameter value in a string format and converts the value to the correct type.
Protected method SetDirectionImpl Sets the direction of the parameter using the DataParameterDirection enumeration.
Protected method SetNameImpl Sets the name of the parameter.
Protected method SetPrecisionImpl Sets a byte value specifying the precision of the parameter.
Protected method SetScaleImpl Sets a byte value specifying the scale of the parameter.
Protected method SetSizeImpl Sets an integer value specifying the size of this parameter.
Protected method SetTypeImpl Sets the data type of this parameter.
Protected method SetValueImpl Sets the value of this parameter.
Public method ToString Retrieves a string representation of the value of this parameter. (Overrides Object.ToString().)
Protected method TryConvertValue Attempts to convert the specified value to the specified type.

Top

Remarks

This class uses an indirect mechanism for implementing parameter properties. Each property get method calls a virtual protected method that retrieves the property. Each property set method, on the other hand, calls three virtual protected methods: one indicating that the property is changing, another actually changing the property, and a third indicating that the property has changed.

This allows the property setter to isolate the handling of invalid input in the property changing method, set the property, and apply any side effects in the property changed method. This also allows the base class to provide some default error checking to match the semantics defined by the parameter interface.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.Data Namespace

AdoDotNetParameter