Execute Method (ADO Command)

Microsoft ActiveX Data Objects (ADO)

ADO 2.5 API Reference

Execute Method (ADO Command)

Executes the query, SQL statement, or stored procedure specified in the CommandText property.

Syntax

For a Recordset-returning Command:

Set recordset = command.Execute( RecordsAffected, Parameters, Options )

For a non–recordset-returning Command:

command.Execute RecordsAffected, Parameters, Options

Return Value

Returns a Recordset object reference or Nothing.

Parameters

RecordsAffected
Optional. A Long variable to which the provider returns the number of records that the operation affected. The RecordsAffected parameter applies only for action queries or stored procedures. RecordsAffected does not return the number of records returned by a result-returning query or stored procedure. To obtain this information, use the RecordCount property. The Execute method will not return the correct information when used with adAsyncExecute, simply because when a command is executed asynchronously, the number of records affected may not yet be known at the time the method returns.
Parameters
Optional. A Variant array of parameter values passed with an SQL statement. (Output parameters will not return correct values when passed in this argument.)
Options
Optional. A Long value that indicates how the provider should evaluate the CommandText property of the Command object. Can be a bitmask value made using CommandTypeEnum and/or ExecuteOptionEnum values. For example, you could use both adCmdText and adExecuteNoRecords together in combination if you want to have ADO evaluate the value of the CommandText property as text and indicate that the command should discard and not return any records that might be generated when the command text executes.

Remarks

Using the Execute method on a Command object executes the query specified in the CommandText property of the object. If the CommandText property specifies a row-returning query, any results that the execution generates are stored in a new Recordset object. If the command is not a row-returning query, the provider returns a closed Recordset object. Some application languages allow you to ignore this return value if no Recordset is desired.

If the query has parameters, the current values for the Command object's parameters are used unless you override these with parameter values passed with the Execute call. You can override a subset of the parameters by omitting new values for some of the parameters when calling the Execute method. The order in which you specify the parameters is the same order in which the method passes them. For example, if there were four (or more) parameters and you wanted to pass new values for only the first and fourth parameters, you would pass Array(var1,,,var4) as the Parameters argument.

Note   Output parameters will not return correct values when passed in the Parameters argument.

An ExecuteComplete event will be issued when this operation concludes.

See Also

Visual Basic Example | VBScript Example | Visual C++ Example | Visual J++ Example |  CommandText Property | CommandTypeEnum | Execute Method (ADO Connection) | ExecuteComplete Event

Applies To: Command Object

© 1998-2002 Microsoft Corporation. All rights reserved.