[#BloombergLP-bdlmt-TimerEventScheduler-cancelEvent-0b]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlmt.adoc[bdlmt]::xref:BloombergLP/bdlmt/TimerEventScheduler.adoc[TimerEventScheduler]::cancelEvent
:relfileprefix: ../../../
:mrdocs:

`cancelEvent` overloads

== Synopses

Declared in `<bdlmt_timereventscheduler.h>`

Cancel the event identified by the specified handle.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
xref:BloombergLP/bdlmt/TimerEventScheduler/cancelEvent-03.adoc[cancelEvent](
    xref:BloombergLP/bdlmt/TimerEventScheduler/Handle.adoc[Handle] handle,
    bool wait = false);
----

[.small]#xref:BloombergLP/bdlmt/TimerEventScheduler/cancelEvent-03.adoc[_» more..._]#

Same as the preceding overload, with the specified `key`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
xref:BloombergLP/bdlmt/TimerEventScheduler/cancelEvent-07.adoc[cancelEvent](
    xref:BloombergLP/bdlmt/TimerEventScheduler/Handle.adoc[Handle] handle,
    xref:BloombergLP/bdlmt/TimerEventScheduler/EventKey.adoc[EventKey] const& key,
    bool wait = false);
----

[.small]#xref:BloombergLP/bdlmt/TimerEventScheduler/cancelEvent-07.adoc[_» more..._]#

== Return Value

0 on successful cancellation, and a non‐zero value otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *handle*
| identifier of the event to cancel
| *wait*
| if true, wait until the dispatcher has resumed
| *key*
| key uniquely identifying the event
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#