[#BaseIndex-StartBackgroundSync]
= xref:BaseIndex.adoc[BaseIndex]::StartBackgroundSync
:relfileprefix: ../
:mrdocs:

Starts the initial sync process on a background thread.

== Synopsis

Declared in `<index/base.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[nodiscard]]
bool
StartBackgroundSync();
----

== Return Value

True if the sync thread was started.

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

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