AdoDotNetParameter Class

Article
10/10/2013

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.Framework.DataParameter
Microsoft.VisualStudio.Data.Framework.AdoDotNet.AdoDotNetParameter

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

Syntax

'Declaration
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(DbParameter)	Initializes a new instance of the AdoDotNetParameter class with a parameter object.
	AdoDotNetParameter(String)	Initializes a new instance of the AdoDotNetParameter class with a parameter string value.
	AdoDotNetParameter(DbParameter, Boolean)	Initializes a new instance of the AdoDotNetParameter class with a parameter object and an indication of whether the parameter is derived using the DeriveParameters method.
	AdoDotNetParameter(String, Boolean)	Initializes a new instance of the AdoDotNetParameter class with the name of the data provider and an indication of whether the parameter is derived using the DeriveParameters method.

Top

Properties

	Name	Description
	DefaultSize	Gets an integer value specifying the default size for the current parameter type. (Inherited from DataParameter.)
	Descriptor	Gets information that describes the data parameter. (Inherited from DataParameter.)
	Direction	Gets or sets a DataParameterDirection object specifying the direction of the parameter. (Inherited from DataParameter.)
	HasDescriptor	Gets a value indicating whether the data parameter exposes its IVsDataParameterDescriptor implementation through the Descriptor property. (Overrides DataParameter.HasDescriptor.)
	IsDerived	Gets a Boolean value that indicates whether the current parameter was derived from the data source. (Inherited from DataParameter.)
	IsFixedSize	Gets a value indicating whether the size for the current parameter type is fixed. (Overrides DataParameter.IsFixedSize.)
	IsNullable	Gets a Boolean value indicating whether the current parameter can have a null value provided that it is derived. (Inherited from DataParameter.)
	IsOptional	Gets a Boolean value indicating whether the current parameter is optional, provided that it is derived. (Inherited from DataParameter.)
	Name	Gets or sets the string literal name of the current parameter. (Inherited from DataParameter.)
	Parameter	Gets the DbParameter object representing the command parameter.
	Size	Gets or sets an integer value specifying the size of the parameter. (Inherited from DataParameter.)
	Type	Gets or sets the data source–specific type of the parameter. (Inherited from DataParameter.)
	Value	Gets 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.)
	GetDirectionCore	Retrieves the parameter direction. (Overrides DataParameter.GetDirectionCore().)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetIsNullableCore	Retrieves a Boolean value indicating whether this parameter can be nulla null reference (Nothing in Visual Basic). (Overrides DataParameter.GetIsNullableCore().)
	GetIsOptionalCore	Retrieves a Boolean value indicating whether the parameter is optional. (Inherited from DataParameter.)
	GetNameCore	Retrieves the name of the parameter. (Overrides DataParameter.GetNameCore().)
	GetSizeCore	Retrieves an integer value specifying the size of the parameter. (Overrides DataParameter.GetSizeCore().)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetTypeCore	Retrieves the data source–specific type of the parameter. (Overrides DataParameter.GetTypeCore().)
	GetTypeFrom	Maps the value type to a DbType value and returns the string equivalent. (Overrides DataParameter.GetTypeFrom(Object).)
	GetValueCore	Retrieves the value of a specified parameter. (Overrides DataParameter.GetValueCore().)
	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.)
	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 parse the input string value into the correct type by using primitive type conversions (like Byte.Parse and Int32.Parse). (Overrides DataParameter.Parse(String).)
	SetDirectionCore	Sets the direction of the parameter by using the DataParameterDirection enumeration. (Overrides DataParameter.SetDirectionCore(DataParameterDirection).)
	SetNameCore	Sets the name of the parameter. (Overrides DataParameter.SetNameCore(String).)
	SetSizeCore	Sets an integer value specifying the size of this parameter. (Overrides DataParameter.SetSizeCore(Int32).)
	SetTypeCore	Attempts to parse the string type into a DbType enumeration value by using Enum.Parse. If this fails, the method assumes DbType.Object as the correct DbType. (Overrides DataParameter.SetTypeCore(String).)
	SetValueCore	Sets the value of the parameter. (Overrides DataParameter.SetValueCore(Object).)
	ToString	Retrieves a string representation of the value of the current 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 use the DbType enumeration when referencing parameter types. This is less than ideal, so it is recommended that providers derive their own classes from this one that override 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.

Share via