ADO » Connection » ConnectComplete
- Syntax:
- ConnectComplete pError, adStatus, pConnection
- pError
- The pError parameter is an Error object that contains information about the occurrence of any errors and/or warnings. This parameter requires that the adStatus parameter be set to the adStatusErrorsOccurred constant, otherwise the Error object is not created.
- adStatus
- The adStatus parameter is normally set to the adStatusOK value of the EventStatusEnum constants. However, if a WillConnect event calls for the cancellation of the pending connection, the adStatus parameter will be set to adStatusCancel.
- pConnection
- The pConnection parameter is the Connection object that is associated with this event.
After a connection has started, you can call this event to provide information on the success of the connection.
The ConnectComplete event can be fired after a connection starts.
This event is one of three connection management events that can be called.
The other two are Disconnect and WillConnect.
An event is simply a subroutine that can be called automatically after a specific operation has occurred.
This subroutine can contain any code that you need to run when the event occurs.
The subroutine will only be called if it is included in your code.
Future calls to the event subroutine can be cancelled by setting
the adStatus parameter to be the adStatusUnwantedEvent constant (see table below) before
the event returns.
There are three parameters that are passed to this event.
EventStatusEnum Constants
| Constant | Value | Description |
|---|---|---|
| adStatusCancel | 4 | Cancels the operation that fired the event |
| adStatusCantDeny | 3 | Cannot cancel pending operation |
| adStatusErrorsOccurred | 2 | Indicates that warnings and/or errors occurred |
| adStatusOK | 1 | The operation that fired the event was successful |
| adStatusUnwantedEvent | 5 | The operation that generated the event cannot generate future events |
Examples
Code:
' Use the WithEvents keyword to designate that events
' can be handled by this Connection object
Dim WithEvents objConn As ADODB.Connection
' Note how the object name, objConn, is incorporated into the event Sub name
Private Sub objConn_ConnectComplete( ByVal pError As ADODB.Error, _
adStatus As ADODB.EventStatusEnum, _
ByVal pConnection As ADODB.Connection )
' place any code you desire here, for example
If adStatus = adStatusErrorsOccurred Then
Print "CONNECTION ERROR: " & pError.Description
End If
End Sub
See Also:
