DataParameter Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Data.Framework

Assembly:: Microsoft.VisualStudio.Data.Framework.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class DataParameter abstract : Microsoft::VisualStudio::Data::Services::SupportEntities::IVsDataParameter, Microsoft::VisualStudio::Data::Services::SupportEntities::IVsDataParameterDescriptor

public abstract class DataParameter : Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter, Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameterDescriptor

type DataParameter = class
    interface IVsDataParameter
    interface IVsDataParameterDescriptor

Public MustInherit Class DataParameter
Implements IVsDataParameter, IVsDataParameterDescriptor

Inheritance: Object
DataParameter

Derived: Microsoft.VisualStudio.Data.Framework.AdoDotNet.AdoDotNetParameter

Implements: IVsDataParameter IVsDataParameterDescriptor

Constructors

DataParameter()	Initializes a new instance of the DataParameter class.
DataParameter(Boolean)	Initializes a new instance of the DataParameter class, specifying whether the instance was derived using the DeriveParameters(String, DataCommandType, Int32) method.

Fields

NullSize

A public size constant holding the value of zero.

Properties

DefaultSize	Gets an integer value specifying the default size for the current parameter type.
Descriptor	Gets information that describes the data parameter.
Direction	Gets or sets a DataParameterDirection object specifying the direction of the parameter.
HasDescriptor	Gets a value indicating whether the data parameter exposes its IVsDataParameterDescriptor implementation through the Descriptor property.
IsDerived	Gets a Boolean value that indicates whether the current parameter was derived from the data source.
IsFixedSize	Gets a Boolean value indicating whether the size for the current parameter type is fixed.
IsNullable	Gets a Boolean value indicating whether the current parameter can have a null value provided that it is derived.
IsOptional	Gets a Boolean value indicating whether the current parameter is optional, provided that it is derived.
Name	Gets or sets the string literal name of the current parameter.
Size	Gets or sets an integer value specifying the size of the parameter.
Type	Gets or sets the data source–specific type of the parameter.
Value	Gets or sets the value of the parameter.

Methods

GetDirectionCore()	Retrieves the parameter direction.
GetIsNullableCore()	Retrieves a Boolean value indicating whether the current parameter can be null.
GetIsOptionalCore()	Retrieves a Boolean value indicating whether the parameter is optional.
GetNameCore()	Retrieves the name of the parameter.
GetSizeCore()	Retrieves an integer value specifying the size of the parameter.
GetTypeCore()	Retrieves the data source–specific type of the parameter.
GetTypeFrom(Object)	Infers the data source–specific parameter type from a parameter value.
GetValueCore()	Retrieves the value of a specified parameter.
IsSupportedDirection(DataParameterDirection)	Retrieves a Boolean value indicating whether the specified parameter direction is supported.
IsValidType(String)	Retrieves a Boolean value indicating whether the specified data source–specific type is a valid type.
OnDirectionChanged()	Called when the Direction property is changed to signal a change in the parameter direction.
OnDirectionChanging(DataParameterDirection)	Called when the Direction property is about to change.
OnNameChanged()	Called when the Name property has changed.
OnNameChanging(String)	Called when the Name property is about to change.
OnSizeChanged()	Called when the Size property has changed.
OnSizeChanging(Int32)	Called when the Size property is about to change.
OnTypeChanged()	Called when the Type property has changed.
OnTypeChanging(String)	Called when the Type property is about to change.
OnValueChanged()	Called when the Value property has changed.
OnValueChanging(Object)	Called when the Value property is about to change.
Parse(String)	Disassembles a parameter value in a string format and converts the value to the correct type.
SetDirectionCore(DataParameterDirection)	Sets the direction of the parameter by using the DataParameterDirection enumeration.
SetNameCore(String)	Sets the name of the parameter.
SetSizeCore(Int32)	Sets an integer value specifying the size of the current parameter.
SetTypeCore(String)	Sets the data type of the current parameter.
SetValueCore(Object)	Sets the value of the parameter.
ToString()	Retrieves a string representation of the value of the current parameter.
TryConvertValue(Object, String)	Attempts to convert the specified value to the specified type.

Applies to