[#llvm-extractBranchWeights-0e8]
= xref:llvm.adoc[llvm]::extractBranchWeights
:relfileprefix: ../
:mrdocs:

Extract branch weights attatched to an Instruction

== Synopsis

Declared in `<llvm/IR/ProfDataUtils.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
bool
extractBranchWeights(
    xref:llvm/Instruction.adoc[Instruction] const& I,
    xref:llvm/SmallVectorImpl-06c.adoc[SmallVectorImpl<uint32_t>]& Weights);
----

== Return Value

True if weights were extracted, False otherwise. When false Weights will be cleared.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *I*
| The Instruction to extract weights from.
| *Weights* [out]
| An output vector to fill with branch weights
|===


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