btck_chain_get_by_height

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>

[[__nonnull__]]
btck_BlockTreeEntry const*
btck_chain_get_by_height(
    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

NameDescription
chain [in]Non-null.
block_height [in]Height in the chain of the to be retrieved block tree entry.