[#btck_context_interrupt]
= btck_context_interrupt
:mrdocs:

Interrupt can be used to halt long‐running validation functions like when reindexing, importing or processing blocks.

== Synopsis

Declared in `<kernel/bitcoinkernel.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[nodiscard, __nonnull__]]
int
btck_context_interrupt(xref:btck_Context-07.adoc[btck_Context]* context);
----

== Return Value

0 if the interrupt was successful, non‐zero otherwise.

[NOTE]
====
The return value https://en.cppreference.com/cpp/language/attributes/nodiscard[should not be discarded^].
====
== Parameters

[cols="1,4"]
|===
| Name| Description
| *context* [in]
| Non‐null.
|===


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