[#btck_chain_get_by_height]
= btck_chain_get_by_height
:mrdocs:

Retrieve a block tree entry by its height in the currently active chain. Once retrieved there is no guarantee that it remains in the active chain.

== Synopsis

Declared in `<kernel/bitcoinkernel.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[__nonnull__]]
xref:btck_BlockTreeEntry-0c.adoc[btck_BlockTreeEntry] const*
btck_chain_get_by_height(
    xref:btck_Chain-09.adoc[btck_Chain] const* chain,
    int32_t block_height);
----

== Return Value

The block tree entry at a certain height in the currently active chain, or null if the height is out of bounds.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *chain* [in]
| Non‐null.
| *block_height* [in]
| Height in the chain of the to be retrieved block tree entry.
|===


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