[#llvm-readModuleSummaryIndex]
= xref:llvm.adoc[llvm]::readModuleSummaryIndex
:relfileprefix: ../
:mrdocs:

Parse the specified bitcode buffer and merge the index into CombinedIndex.

== Synopsis

Declared in `<llvm/Bitcode/BitcodeReader.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:llvm/Error.adoc[Error]
readModuleSummaryIndex(
    xref:llvm/MemoryBufferRef.adoc[MemoryBufferRef] Buffer,
    xref:llvm/ModuleSummaryIndex.adoc[ModuleSummaryIndex]& CombinedIndex);
----

== Return Value

Error::success() on success, or an Error describing the failure.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *Buffer*
| Memory buffer containing the bitcode.
| *CombinedIndex*
| Summary index that receives merged entries.
|===


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