DataCommand.DeriveParameters Method
Definition
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.
Overloads
| DeriveParameters(String) |
Derives the parameters that can be specified for a given command. |
| DeriveParameters(String, DataCommandType) |
Derives the parameters that can be specified for a given command. |
| DeriveParameters(String, DataCommandType, Int32) |
Derives the parameters that can be specified for a given command. |
DeriveParameters(String)
Derives the parameters that can be specified for a given command.
public:
virtual cli::array <Microsoft::VisualStudio::Data::Services::SupportEntities::IVsDataParameter ^> ^ DeriveParameters(System::String ^ command);public Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[] DeriveParameters (string command);abstract member DeriveParameters : string -> Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[]
override this.DeriveParameters : string -> Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[]Public Function DeriveParameters (command As String) As IVsDataParameter()Parameters
- command
- String
A command from which to derive parameters specific to a data source.
Returns
An array of IVsDataParameter objects. Each object represents a parameter that is derived from the command.
Implements
Exceptions
The command parameter is null.
Applies to
DeriveParameters(String, DataCommandType)
Derives the parameters that can be specified for a given command.
public:
virtual cli::array <Microsoft::VisualStudio::Data::Services::SupportEntities::IVsDataParameter ^> ^ DeriveParameters(System::String ^ command, Microsoft::VisualStudio::Data::Services::SupportEntities::DataCommandType commandType);public Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[] DeriveParameters (string command, Microsoft.VisualStudio.Data.Services.SupportEntities.DataCommandType commandType);abstract member DeriveParameters : string * Microsoft.VisualStudio.Data.Services.SupportEntities.DataCommandType -> Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[]
override this.DeriveParameters : string * Microsoft.VisualStudio.Data.Services.SupportEntities.DataCommandType -> Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[]Public Function DeriveParameters (command As String, commandType As DataCommandType) As IVsDataParameter()Parameters
- command
- String
A command from which to derive parameters specific to a data source.
- commandType
- DataCommandType
The type of the command that specifies how to interpret the contents of the command parameter. The command type could either be a value from the DataCommandType enumeration or a custom command type defined by a provider, which can be passed in by forcing a cast from an integer to the DataCommandType enumeration.
Returns
An array of IVsDataParameter objects. Each object represents a parameter derived from the command.
Implements
Exceptions
The command parameter is null.
Applies to
DeriveParameters(String, DataCommandType, Int32)
Derives the parameters that can be specified for a given command.
public:
virtual cli::array <Microsoft::VisualStudio::Data::Services::SupportEntities::IVsDataParameter ^> ^ DeriveParameters(System::String ^ command, Microsoft::VisualStudio::Data::Services::SupportEntities::DataCommandType commandType, int commandTimeout);public virtual Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[] DeriveParameters (string command, Microsoft.VisualStudio.Data.Services.SupportEntities.DataCommandType commandType, int commandTimeout);abstract member DeriveParameters : string * Microsoft.VisualStudio.Data.Services.SupportEntities.DataCommandType * int -> Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[]
override this.DeriveParameters : string * Microsoft.VisualStudio.Data.Services.SupportEntities.DataCommandType * int -> Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[]Public Overridable Function DeriveParameters (command As String, commandType As DataCommandType, commandTimeout As Integer) As IVsDataParameter()Parameters
- command
- String
A command from which to derive parameters specific to a data source.
- commandType
- DataCommandType
The type of the command that specifies how to interpret the contents of the command parameter. The command type could either be a value from the DataCommandType enumeration or a custom command type defined by a provider, which can be passed in by forcing a cast from an integer to the DataCommandType enumeration.
- commandTimeout
- Int32
The length of time, in seconds, to block the client before canceling the parameter derivation and returning to the caller. A value of 0 indicates infinite time-out; a value of -1 indicates a provider default.
Returns
An array of IVsDataParameter objects. Each object represents a parameter derived from the command.
Implements
Exceptions
The command parameter is null.
The commandTimeout parameter is less than -1.