Edit

WillExecute Event (ADO)

  • Article

The WillExecute event is called just before a pending command executes on a connection.

Syntax

  
WillExecute Source, CursorType, LockType, Options, adStatus, pCommand, pRecordset, pConnection

Parameters

Source
A String that contains an SQL command or a stored procedure name.

CursorType
A CursorTypeEnum that contains the type of cursor for the Recordset that will be opened. With this parameter, you can change the cursor to any type during a RecordsetOpen Method (ADO Recordset) operation. CursorType will be ignored for any other operation.

LockType
A LockTypeEnum that contains the lock type for the Recordset that will be opened. With this parameter, you can change the lock to any type during a RecordsetOpen operation. LockType will be ignored for any other operation.

Options
A Long value that indicates options that can be used to execute the command or open the Recordset.

adStatus
An EventStatusEnum status value that may be adStatusCantDeny or adStatusOK when this event is called. If it is adStatusCantDeny, this event may not request cancellation of the pending operation.

pCommand
The Command Object (ADO) object for which this event notification applies.

pRecordset
The Recordset Object (ADO) object for which this event notification applies.

pConnection
The Connection Object (ADO) object for which this event notification applies.

Remarks

A WillExecute event may occur due to a Connection. Execute Method (ADO Connection), Execute Method (ADO Command), or Open Method (ADO Recordset) method The pConnection parameter should always contain a valid reference to a Connection object. If the event is due to Connection.Execute, the pRecordset and pCommand parameters are set to Nothing. If the event is due to Recordset.Open, the pRecordset parameter will reference the Recordset object and the pCommand parameter is set to Nothing. If the event is due to Command.Execute, the pCommand parameter will reference the Command object and the pRecordset parameter is set to Nothing.

WillExecute allows you to examine and modify the pending execution parameters. This event may return a request that the pending command be canceled.

Note

If the original source for a Command is a stream specified by the CommandStream Property (ADO) property, assigning a new string to the WillExecuteSource parameter changes the source of the Command. The CommandStream property will be cleared and the CommandText Property (ADO) property will be updated with the new source. The original stream specified by CommandStream will be released and cannot be accessed.

If the dialect of the new source string differs from the original setting of the Dialect Property property (which corresponded to the CommandStream), the correct dialect must be specified by setting the Dialect property of the command object referenced by pCommand.

See Also

ADO Events Model Example (VC++)
ADO Event Handler Summary
Connection Object (ADO)