[#BloombergLP-bdlmt-TimerEventScheduler-cancelClock]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlmt.adoc[bdlmt]::xref:BloombergLP/bdlmt/TimerEventScheduler.adoc[TimerEventScheduler]::cancelClock
:relfileprefix: ../../../
:mrdocs:

Cancel the clock having the specified `handle`. If the optionally specified `wait` is true, then ensure that any scheduled event for the clock having `handle` is either cancelled or has been dispatched before this call returns. Return 0 on success, and a non‐zero value if the `handle` is invalid. If this method is being invoked from the dispatcher thread, then the `wait` is ignored to avoid deadlock.

== Synopsis

Declared in `<bdlmt_timereventscheduler.h>`

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


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