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

Get a summary of the index and its state&period;

== Synopsis

Declared in `&lt;index&sol;base&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:IndexSummary.adoc[IndexSummary]
GetSummary() const;
----

== Return Value

A snapshot of the index name and sync progress&period;


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