[#btck-ContextOptions]
= xref:btck.adoc[btck]::ContextOptions
:relfileprefix: ../
:mrdocs:

Owning wrapper over `btck_ContextOptions`, configuring a Context before creation.

== Synopsis

Declared in `<kernel/bitcoinkernel_wrapper.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class ContextOptions
    : public xref:btck/UniqueHandle-0da.adoc[UniqueHandle<btck_ContextOptions, btck_context_options_destroy>]
----

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:btck/UniqueHandle-0da.adoc[UniqueHandle<btck_ContextOptions, btck_context_options_destroy>]`
| Owning RAII handle for a non‐copyable C object, backed by std::unique_ptr.
|===

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:btck/ContextOptions/2constructor.adoc[`ContextOptions`]         [.small]#[constructor]#
| Constructs an empty set of context options.
| xref:btck/ContextOptions/SetChainParams.adoc[`SetChainParams`] 
| Sets the chain parameters for the context.
| xref:btck/ContextOptions/SetNotifications.adoc[`SetNotifications`] 
| Registers a kernel notification handler for the context.
| xref:btck/ContextOptions/SetValidationInterface.adoc[`SetValidationInterface`] 
| Registers a validation event handler for the context.
| xref:btck/ContextOptions/get-04.adoc[`get`] 
| Returns the owned C handle.
|===


== Protected Types

[cols="1,4"]
|===
| Name| Description
| xref:btck/ContextOptions/Deleter.adoc[`Deleter`] 
| Custom deleter that forwards to the C destroy function.
|===


== Protected Data Members

[cols="1,4"]
|===
| Name| Description
| xref:btck/ContextOptions/m_ptr.adoc[`m_ptr`] 
| The owned C handle.
|===



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