RegisterForEvent(const char *, const char *, const char *, bool) method

RegisterForEvent(const char , const char , const char *, bool) method

Registers or unregisters a queue to receive notifications of an event.

Syntax

public virtual bool RegisterForEvent(
    const char * eventName,
    const char * objectName,
    const char * queueName,
    bool register_not_unreg
)

Parameters

eventName The system or user-defined event to register for.
objectName The object to which the event applies (like table name).
queueName NULL means default connection queue.
register_not_unreg True to register, false to unregister.

If no queue name is supplied, the default connection queue is implied, and created if required. Certain system events allow specification of an object name to which the event applies. For example, the TableModified event can specify the table name. Unlike SendNotification(), only the specific queue registered receives notifications of the event. Other queues with the same name on different connections do not, unless they are also explicit registered.

The predefined system events are:

TableModified Triggered when rows in a table are inserted, updated, or deleted. One notification is sent per request, no matter how many rows were affected by the request. The object_name parameter specifies the table to monitor. A value of "*" means all tables in the database. This event has a parameter named 'table_name' whose value is the name of the modified table.
Commit Triggered after any commit completes. This event has no parameters.
SyncComplete Triggered after synchronization completes. This event has no parameters.

Discuss this page in DocCommentXchange.

RegisterForEvent(const char , const char , const char *, bool) method

Syntax

Parameters

Returns

Remarks