DataAsyncCommand.OnPrepare 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.
Dispatches the asynchronous prepare operation to the synchronous Prepare(String, DataCommandType, IVsDataParameter[], Int32) method call.
protected:
virtual System::String ^ OnPrepare(System::String ^ command, Microsoft::VisualStudio::Data::Services::SupportEntities::DataCommandType commandType, cli::array <Microsoft::VisualStudio::Data::Services::SupportEntities::IVsDataParameter ^> ^ parameters, int commandTimeout);protected virtual string OnPrepare (string command, Microsoft.VisualStudio.Data.Services.SupportEntities.DataCommandType commandType, Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[] parameters, int commandTimeout);abstract member OnPrepare : string * Microsoft.VisualStudio.Data.Services.SupportEntities.DataCommandType * Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[] * int -> string
override this.OnPrepare : string * Microsoft.VisualStudio.Data.Services.SupportEntities.DataCommandType * Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[] * int -> stringProtected Overridable Function OnPrepare (command As String, commandType As DataCommandType, parameters As IVsDataParameter(), commandTimeout As Integer) As StringParameters
- command
- String
The command for which the schema is derived.
- commandType
- DataCommandType
A value from the DataCommandType enumeration representing the command type for the indicated command. The value specifies how to interpret the contents of the command parameter.
- parameters
- IVsDataParameter[]
A list of parameters to pass with the command.
- commandTimeout
- Int32
Amount of time, in seconds, before which the command times out.
Returns
An identifier of the prepared command that can later be passed to the Execute(String, DataCommandType, IVsDataParameter[], Int32) or ExecuteWithoutResults(String, DataCommandType, IVsDataParameter[], Int32) methods by using the command type Prepared.