isc_cancel_events()

From InterBase
Jump to: navigation, search

Go Up to API Function Reference


Cancels an application interest in asynchronous notification of any of a specified group of events.

Syntax

 ISC_STATUS isc_cancel_events(
 ISC_STATUS *status_vector, 
 isc_db_handle *db_handle, 
 ISC_LONG *event_id);
Parameter Type Description

status_vector

ISC_STATUS *

Pointer to the error status vector

db_handle

isc_db_handle *

Pointer to a database handle set by a previous call to isc_attach_database(); the handle identifies the database for which the event watch is to be canceled.

db_handle returns an error in status_vector if it is NULL.

event_id

ISC_LONG *

Pointer to the event or events to cancel; set by a previous call to isc_que_events().

Description

isc_cancel_events() cancels an asynchronous wait of an application program for any of a specified list of events. The events are the ones that were associated with event_id as a result of a previous call to isc_que_events().

Example

The following call cancels a program wait for events associated with event_id, where event_id was previously returned from a call to isc_que_events():

isc_cancel_events(status_vector, &database_handle, &event_id);

A more complete example is provided in the section on isc_que_events().

Return value

isc_cancel_events() returns the second element of the status vector. Zero indicates success. A nonzero value indicates an error. For InterBase errors, the first element of the status vector is set to 1, and the second element is set to an InterBase error code.

To check for an InterBase error, examine the first two elements of the status vector directly. For more information about examining the status vector, see Handling Error Conditions.

See Also

Advance To: