Help Center

CAdoConnection.CommandTimeoutproperty

Sets or returns a Long value that indicates, in seconds, how long to wait for a command to execute. Default is 30.

DatabasespropertyCAdoConnection.incdocumented

Syntax

PROPERTY CommandTimeout () AS LONG
PROPERTY CommandTimeout (BYVAL lTimeout AS LONG)

Parameters

NameDescription
lTimeoutTime to wait for a command to execute.

Return value

The timeout value.

Description

Sets or returns a Long value that indicates, in seconds, how long to wait for a command to execute. Default is 30.

Remarks

Use the CommandTimeout property on a Connection object to allow the cancellation of an Execute method call, due to delays from network traffic or heavy server use. If the interval set in the CommandTimeout property elapses before the command completes execution, an error occurs and ADO cancels the command. If you set the property to zero, ADO will wait indefinitely until the execution is complete. Make sure the provider and data source to which you are writing code support the CommandTimeout functionality.

The CommandTimeout setting on a Connection object has no effect on the CommandTimeout setting on a Command object on the same Connection; that is, the Command object's CommandTimeout property does not inherit the value of the Connection object's CommandTimeout value.

On a Connection object, the CommandTimeout property remains read/write after the Connection is opened.

Examples

' // Sets the timeout to 35 seconds pConnection.CommandTimeout = 35

' // Gets the timeout value DIM lTimeout AS LONG = pConnection.CommandTimeout

Reference

  • Include file CAdoConnection.inc
  • Defined in AfxNova/CAdoConnection.inc:272
  • Documented in Databases/ADO Classes/CAdoConnection Class.md
  • Topic: CAdoConnection Class