DataCommand.DeriveParameters Method

Article
2011-02-23

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

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

Syntax

'Declaration
Public Overridable Function DeriveParameters ( _
    command As String, _
    commandType As Integer, _
    commandTimeout As Integer _
) As DataParameter()

public virtual DataParameter[] DeriveParameters(
    string command,
    int commandType,
    int commandTimeout
)

public:
virtual array<DataParameter^>^ DeriveParameters(
    String^ command, 
    int commandType, 
    int commandTimeout
)

abstract DeriveParameters : 
        command:string * 
        commandType:int * 
        commandTimeout:int -> DataParameter[] 
override DeriveParameters : 
        command:string * 
        commandType:int * 
        commandTimeout:int -> DataParameter[]

public function DeriveParameters(
    command : String, 
    commandType : int, 
    commandTimeout : int
) : DataParameter[]

Parameters

command
Type: System.String
A command from which to derive parameters specific to a data source.

commandType
Type: System.Int32
The command type for the indicated command, specifying how to interpret the contents of the command parameter.

commandTimeout
Type: System.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.

Return Value

Type: array<Microsoft.VisualStudio.Data.DataParameter[]
Returns an array of DataParameter objects. Each object represents a parameter derived from the command.

Exceptions

Exception	Condition
ArgumentNullException	The command or asyncCommandEvents are null.
ArgumentException	The commandType specifies an invalid type.
ArgumentOutOfRangeException	The commandTimeout is less than -1.
NotSupportedException	The provider does not support this method.

Remarks

Once the instances of the derived parameter objects are retrieved, the client owns them and can modify their values as needed; the client will then pass these values to an Execute

or ExecuteWithoutResults

call.

Note

Other exceptions that occur indicate that the parameter derivation failed for a provider-specified reason.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via