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

Extract branch weights from a conditional branch or select Instruction.

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
bool
extractBranchWeights(
    xref:llvm/Instruction.adoc[Instruction] const& I,
    uint64_t& TrueVal,
    uint64_t& FalseVal);
----

== Return Value

True on success with profile weights filled in. False if no metadata or invalid metadata was found.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *I*
| The instruction to extract branch weights from.
| *TrueVal* [out]
| will contain the branch weight for the True branch
| *FalseVal* [out]
| will contain the branch weight for the False branch
|===


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