AdoDotNetParameter Class
Represents a data parameter that is derived from a data source command, or that is passed with a command to a data source whose underlying technology is ADO.NET.
Inheritance Hierarchy
System.Object
Microsoft.VisualStudio.Data.DataParameter
Microsoft.VisualStudio.Data.AdoDotNet.AdoDotNetParameter
Namespace: Microsoft.VisualStudio.Data.AdoDotNet
Assembly: Microsoft.VisualStudio.Data (in Microsoft.VisualStudio.Data.dll)
Syntax
'Déclaration
Public Class AdoDotNetParameter _
Inherits DataParameter
public class AdoDotNetParameter : DataParameter
public ref class AdoDotNetParameter : public DataParameter
type AdoDotNetParameter =
class
inherit DataParameter
end
public class AdoDotNetParameter extends DataParameter
The AdoDotNetParameter type exposes the following members.
Constructors
Name | Description | |
---|---|---|
AdoDotNetParameter(String) | Class constructor. Initializes a parameterized instance of the AdoDotNetParameter class, along with the name of the ADO.NET data provider being serviced by the connection. | |
AdoDotNetParameter(String, IDataParameter) | Class constructor. Initializes a parameterized instance of the AdoDotNetParameter class, providing a parameter for a Command object and the name of the DDEX provider. | |
AdoDotNetParameter(String, IDataParameter, Boolean) | Class constructor. Initializes a parameterized instance of the AdoDotNetParameter class, providing a parameter for a Command object, the name of the DDEX provider, and an indication whether the parameter is derived using the DeriveParameters method. |
Top
Properties
Name | Description | |
---|---|---|
DefaultPrecision | Retrieves a byte value specifying the default precision for the current parameter type. (Inherited from DataParameter.) | |
DefaultScale | Retrieves a byte value specifying the default scale for the current parameter type. (Inherited from DataParameter.) | |
DefaultSize | Retrieves and integer value specifying the default size for the current parameter type. (Inherited from DataParameter.) | |
Direction | Retrieves or sets a DataParameterDirection object specifying the direction of the parameter. (Inherited from DataParameter.) | |
IsDerived | Retrieves a Boolean value that indicates whether this parameter was derived from the data source. (Inherited from DataParameter.) | |
IsFixedPrecision | Retrieves a Boolean value indicating whether the precision for the current parameter type is fixed. (Overrides DataParameter.IsFixedPrecision.) | |
IsFixedScale | Retrieves a Boolean value indicating whether the scale for the current parameter type is fixed. (Overrides DataParameter.IsFixedScale.) | |
IsFixedSize | Retrieves a Boolean value indicating whether the size for the current parameter type is fixed. (Overrides DataParameter.IsFixedSize.) | |
IsNullable | Retrieves a Boolean value indicating whether this parameter can have a nulla null reference (Nothing in Visual Basic) value. (Inherited from DataParameter.) | |
IsOptional | Retrieves a Boolean value indicating whether this parameter is optional, in cases where this parameter is a derived parameter. (Inherited from DataParameter.) | |
Name | Retrieves or sets the string literal name of the parameter. (Inherited from DataParameter.) | |
Parameter | Retrieves the IDataParameter object representing the command parameter. | |
Precision | Retrieves or sets a byte value specifying the precision of the parameter. (Inherited from DataParameter.) | |
Scale | Retrieves or sets a byte value specifying the scale of the parameter. (Inherited from DataParameter.) | |
Size | Retrieves or sets an integer value specifying the size of the parameter. (Inherited from DataParameter.) | |
Type | Retrieves or sets the data-source-specific type of the parameter. (Inherited from DataParameter.) | |
Value | Retrieves or sets the value of the parameter. (Inherited from DataParameter.) |
Top
Methods
Name | Description | |
---|---|---|
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetDirectionImpl | Retrieves the parameter direction. (Overrides DataParameter.GetDirectionImpl().) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetIsNullableImpl | Retrieves a Boolean value indicating whether this parameter can be nulla null reference (Nothing in Visual Basic). (Overrides DataParameter.GetIsNullableImpl().) | |
GetIsOptionalImpl | Retrieves a Boolean value indicating whether this parameter is optional. (Inherited from DataParameter.) | |
GetNameImpl | Retrieves the name of the parameter. (Overrides DataParameter.GetNameImpl().) | |
GetPrecisionImpl | Retrieves a byte value specifying the precision of the parameter. (Overrides DataParameter.GetPrecisionImpl().) | |
GetScaleImpl | Retrieves a byte value specifying the scale of the parameter. (Overrides DataParameter.GetScaleImpl().) | |
GetSizeImpl | Retrieves an integer value specifying the size of the parameter. (Overrides DataParameter.GetSizeImpl().) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetTypeFrom | Returns a AnsiString for a nulla null reference (Nothing in Visual Basic) or DBNull value; alternatively maps the value type to a DbType value and returns the string equivalent. (Overrides DataParameter.GetTypeFrom(Object).) | |
GetTypeImpl | Retrieves the data-source-specific type of the parameter. (Overrides DataParameter.GetTypeImpl().) | |
GetValueImpl | Retrieves the value of a specified parameter. (Overrides DataParameter.GetValueImpl().) | |
IsSupportedDirection | Retrieves a Boolean value indicating whether the specified parameter direction is supported. (Inherited from DataParameter.) | |
IsValidType | Retrieves a Boolean value indicating whether the specified data-source-specific type is a valid type. (Overrides DataParameter.IsValidType(String).) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OnDirectionChanged | Called when the Direction property is changed to signal a change in the parameter direction. (Inherited from DataParameter.) | |
OnDirectionChanging | Called when the Direction property is about to change. (Inherited from DataParameter.) | |
OnNameChanged | Called when the Name property has changed. (Inherited from DataParameter.) | |
OnNameChanging | Called when the Name property is about to change. (Inherited from DataParameter.) | |
OnPrecisionChanged | Called when the Precision property has changed. (Inherited from DataParameter.) | |
OnPrecisionChanging | Called when the Precision property is about to change. (Inherited from DataParameter.) | |
OnScaleChanged | Called when the Scale property has changed. (Inherited from DataParameter.) | |
OnScaleChanging | Called when the Scale property is about to change. (Inherited from DataParameter.) | |
OnSizeChanged | Called when the Size property has changed. (Inherited from DataParameter.) | |
OnSizeChanging | Called when the Size property is about to change. (Inherited from DataParameter.) | |
OnTypeChanged | Called when the Type property has changed. (Inherited from DataParameter.) | |
OnTypeChanging | Called when the Type property is about to change. (Inherited from DataParameter.) | |
OnValueChanged | Called when the Value property has changed. (Inherited from DataParameter.) | |
OnValueChanging | Called when the Value property is about to change. (Inherited from DataParameter.) | |
Parse | Gets the DbType and attempts to parts the input string value into the correct type using primitive type conversions (like Byte.Parse and Int32.Parse). (Overrides DataParameter.Parse(String).) | |
SetDirectionImpl | Sets the direction of the parameter using the DataParameterDirection enumeration. (Overrides DataParameter.SetDirectionImpl(DataParameterDirection).) | |
SetNameImpl | Sets the name of the parameter. (Overrides DataParameter.SetNameImpl(String).) | |
SetPrecisionImpl | Sets a byte value specifying the precision of the parameter. (Overrides DataParameter.SetPrecisionImpl(Byte).) | |
SetScaleImpl | Sets a byte value specifying the scale of the parameter. (Overrides DataParameter.SetScaleImpl(Byte).) | |
SetSizeImpl | Sets an integer value specifying the size of this parameter. (Overrides DataParameter.SetSizeImpl(Int32).) | |
SetTypeImpl | Attempts to parse the string type into a DbType enumeration value using Enum.Parse and if this fails it assumes DbType.Object as the correct DbType. (Overrides DataParameter.SetTypeImpl(String).) | |
SetValueImpl | Sets the value of this parameter. (Overrides DataParameter.SetValueImpl(Object).) | |
ToString | Retrieves a string representation of the value of this parameter. (Inherited from DataParameter.) | |
TryConvertValue | Attempts to convert the specified value to the specified type. (Inherited from DataParameter.) |
Top
Remarks
This class provides a complete managed implementation that will be created by default from the AdoDotNetConnectionSupport class. The base implementation will deal in terms of the DbType enumeration when referencing parameter types. This is less than ideal, so it is recommended that a provider derive their own class from this one that overrides the various methods and properties to more closely represent their back-end-specific types and restrictions.
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.