DataAsyncCommand.AsyncExecute Method
Executes a command in an asynchronous manner.
Namespace: Microsoft.VisualStudio.Data
Assembly: Microsoft.VisualStudio.Data (in Microsoft.VisualStudio.Data.dll)
Syntax
Public Overridable Sub AsyncExecute ( _
command As String, _
commandType As Integer, _
parameters As DataParameter(), _
commandTimeout As Integer, _
asyncCommandEvents As DataAsyncCommandEvents _
)
Dim instance As DataAsyncCommand
Dim command As String
Dim commandType As Integer
Dim parameters As DataParameter()
Dim commandTimeout As Integer
Dim asyncCommandEvents As DataAsyncCommandEvents
instance.AsyncExecute(command, commandType, _
parameters, commandTimeout, asyncCommandEvents)
public virtual void AsyncExecute(
string command,
int commandType,
DataParameter[] parameters,
int commandTimeout,
DataAsyncCommandEvents asyncCommandEvents
)
public:
virtual void AsyncExecute(
String^ command,
int commandType,
array<DataParameter^>^ parameters,
int commandTimeout,
DataAsyncCommandEvents^ asyncCommandEvents
)
public function AsyncExecute(
command : String,
commandType : int,
parameters : DataParameter[],
commandTimeout : int,
asyncCommandEvents : DataAsyncCommandEvents
)
Parameters
command
Type: System.StringThe command to be executed.
commandType
Type: System.Int32Format of the command string.
parameters
Type: array<Microsoft.VisualStudio.Data.DataParameter[]A list of parameters to pass with the command.
commandTimeout
Type: System.Int32Amount of time, in seconds, before which the command times out.
asyncCommandEvents
Type: Microsoft.VisualStudio.Data.DataAsyncCommandEventsThe object on which this method calls back as the command progresses.
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
This method performs the same operation as the Execute method, but in an asynchronous manner.
If the value of the commandTimeout parameter is 0, there is no timeout (or, timeout is infinite); if the value is -1, the timeout period is that set by the data provider.
Notes
Other exceptions that occur indicate that the parameter derivation failed for a provider-specified reason.
Permissions
- 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.