Page tree
Skip to end of metadata
Go to start of metadata

Registers an event sink. An event sink is an object that can processes events when they are triggered with EventProcessEvent.

Registered event syncs appear as items that you can chose for event processing when you double click an event in the events panel.

Syntax

Parameters

sinkName
Type: LocString
The LocString that describes the name of your event sink. 
pSinkInterface
Pointer to an interface that will handle the event processing
pSinkContext
Type: void *
Arbitrary context data that is passed to the sink processing interface
phSink
Type: EventHandle *
Pointer to an EventHandle that will received the sink object created with EventRegisterSink. Use this returned handle to deregister the sink with EventDeregisterSink

Return Value

Type: bool
If the sink was registered successfully then true is returned. Otherwise false is returned.

Remarks

Registering an event sink does not attach the sink to any events. To attach your sink to events call EventAttachSink

Examples

See Also