[#BloombergLP-bdlmt-EventScheduler-cancelEvent-01]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlmt.adoc[bdlmt]::xref:BloombergLP/bdlmt/EventScheduler.adoc[EventScheduler]::cancelEvent
:relfileprefix: ../../../
:mrdocs:

`cancelEvent` overloads

== Synopses

Declared in `<bdlmt_eventscheduler.h>`

Cancel the event referred to by `handle` and release the handle.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
xref:BloombergLP/bdlmt/EventScheduler/cancelEvent-0ab.adoc[cancelEvent](xref:BloombergLP/bdlmt/EventScheduler/EventHandle.adoc[EventHandle]* handle);
----

[.small]#xref:BloombergLP/bdlmt/EventScheduler/cancelEvent-0ab.adoc[_» more..._]#

Same as the preceding overload, for a recurring‐event handle.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
xref:BloombergLP/bdlmt/EventScheduler/cancelEvent-0ae.adoc[cancelEvent](xref:BloombergLP/bdlmt/EventScheduler/RecurringEventHandle.adoc[RecurringEventHandle]* handle);
----

[.small]#xref:BloombergLP/bdlmt/EventScheduler/cancelEvent-0ae.adoc[_» more..._]#

Cancel the event referred to by the specified `handle`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
xref:BloombergLP/bdlmt/EventScheduler/cancelEvent-05.adoc[cancelEvent](xref:BloombergLP/bdlmt/EventScheduler/Event.adoc[Event] const* handle);
----

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

Same as the preceding overload, for a recurring event.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
xref:BloombergLP/bdlmt/EventScheduler/cancelEvent-0c.adoc[cancelEvent](xref:BloombergLP/bdlmt/EventScheduler/RecurringEvent.adoc[RecurringEvent] const* handle);
----

[.small]#xref:BloombergLP/bdlmt/EventScheduler/cancelEvent-0c.adoc[_» more..._]#

== Return Value

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

== Parameters

[cols="1,4"]
|===
| Name| Description
| *handle*
| event handle to cancel and release
|===


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