DataCommand.DeriveParameters(String, Int32, Int32) Method

Definition

Derives the parameters that can be specified for a given command.

public:
 virtual cli::array <Microsoft::VisualStudio::Data::DataParameter ^> ^ DeriveParameters(System::String ^ command, int commandType, int commandTimeout);
public virtual Microsoft.VisualStudio.Data.DataParameter[] DeriveParameters (string command, int commandType, int commandTimeout);
abstract member DeriveParameters : string * int * int -> Microsoft.VisualStudio.Data.DataParameter[]
override this.DeriveParameters : string * int * int -> Microsoft.VisualStudio.Data.DataParameter[]
Public Overridable Function DeriveParameters (command As String, commandType As Integer, commandTimeout As Integer) As DataParameter()

Parameters

command
String

A command from which to derive parameters specific to a data source.

commandType
Int32

The command type for the indicated command, specifying how to interpret the contents of the command parameter.

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 timeout; a value of -1 indicates a provider default.

Returns

Returns an array of DataParameter objects. Each object represents a parameter derived from the command.

Exceptions

The command or asyncCommandEvents are null.

The commandType specifies an invalid type.

The commandTimeout is less than -1.

The provider does not support this method.

Applies to