[#InitBlockFilterIndex]
= InitBlockFilterIndex
:mrdocs:

Initialize a block filter index for the given type if one does not already exist. Returns true if a new index is created and false if one has already been initialized.

== Synopsis

Declared in `<index/blockfilterindex.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
bool
InitBlockFilterIndex(
    std::function<std::unique_ptr<interfaces::Chain>()> make_chain,
    xref:BlockFilterType.adoc[BlockFilterType] filter_type,
    size_t n_cache_size,
    bool f_memory = false,
    bool f_wipe = false);
----

== Return Value

True if a new index was created, false if one already existed.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *make_chain*
| Factory that creates a chain interface for the index.
| *filter_type*
| Filter type of the index to create.
| *n_cache_size*
| Size of the database cache, in bytes.
| *f_memory*
| Keep the database in memory instead of on disk.
| *f_wipe*
| Erase any existing database before opening.
|===


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