WillChangeRecordset and RecordsetChangeComplete events (ADO)
Applies to: Access 2013, Office 2013
The WillChangeRecordset event is called before a pending operation changes the Recordset. The RecordsetChangeComplete event is called after the Recordset has changed.
Syntax
WillChangeRecordsetadReason, adStatus, pRecordset
RecordsetChangeCompleteadReason, pError, adStatus, pRecordset
Parameters
| Parameter | Description |
|---|---|
| adReason | An EventReasonEnum value that specifies the reason for this event. Its value can be adRsnRequery, adRsnResynch, adRsnClose, adRsnOpen. |
| adStatus | EventStatusEnum. When WillChangeRecordset is called, this parameter is set to adStatusOK if the operation that caused the event was successful. It is set to adStatusCantDeny if this event cannot request cancellation of the pending operation. When RecordsetChangeComplete is called, this parameter is set to adStatusOK if the operation that caused the event was successful, adStatusErrorsOccurred if the operation failed, or adStatusCancel if the operation associated with the previously accepted WillChangeRecordset event has been canceled. Before WillChangeRecordset returns, set this parameter to adStatusCancel to request cancellation of the pending operation or set this parameter to adStatusUnwantedEvent to prevent subsequent notifications. Before WillChangeRecordset or RecordsetChangeComplete returns, set this parameter to adStatusUnwantedEvent to prevent subsequent notifications. |
| pError | An Error object. It describes the error that occurred if the value of adStatus is adStatusErrorsOccurred; otherwise it is not set. |
| pRecordset | A Recordset object. The Recordset for which this event occurred. |
Remarks
A WillChangeRecordset or RecordsetChangeComplete event may occur due to the Recordset Requery or Open methods.
If the provider does not support bookmarks, a RecordsetChange event notification occurs each time new rows are retrieved from the provider. The frequency of this event depends on the RecordsetCacheSize property.
You must set the adStatus parameter to adStatusUnwantedEvent for each possible adReason value in order to completely stop event notification for any event that includes an adReason parameter.