[#llvm-PointerMayBeCapturedBefore-0b]
= xref:llvm.adoc[llvm]::PointerMayBeCapturedBefore
:relfileprefix: ../
:mrdocs:

`PointerMayBeCapturedBefore` overloads

== Synopses

Declared in `<llvm/Analysis/CaptureTracking.h>`

Return true if this pointer may be captured before a given instruction.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
bool
xref:llvm/PointerMayBeCapturedBefore-08.adoc[PointerMayBeCapturedBefore](
    xref:llvm/Value.adoc[Value] const* V,
    bool ReturnCaptures,
    xref:llvm/Instruction.adoc[Instruction] const* I,
    xref:llvm/DominatorTree.adoc[DominatorTree] const* DT,
    bool IncludeI = false,
    unsigned int MaxUsesToExplore = 0,
    xref:llvm/LoopInfo.adoc[LoopInfo] const* LI = nullptr);
----

[.small]#xref:llvm/PointerMayBeCapturedBefore-08.adoc[_» more..._]#

Return which components of the pointer may be captured on the path to `I.`


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:llvm/CaptureComponents.adoc[CaptureComponents]
xref:llvm/PointerMayBeCapturedBefore-0c.adoc[PointerMayBeCapturedBefore](
    xref:llvm/Value.adoc[Value] const* V,
    bool ReturnCaptures,
    xref:llvm/Instruction.adoc[Instruction] const* I,
    xref:llvm/DominatorTree.adoc[DominatorTree] const* DT,
    bool IncludeI,
    xref:llvm/CaptureComponents.adoc[CaptureComponents] Mask,
    xref:llvm/function_ref-03.adoc[function_ref<bool(xref:llvm/CaptureComponents.adoc[CaptureComponents])>] StopFn = capturesAnything,
    xref:llvm/LoopInfo.adoc[LoopInfo] const* LI = nullptr,
    unsigned int MaxUsesToExplore = 0);
----

[.small]#xref:llvm/PointerMayBeCapturedBefore-0c.adoc[_» more..._]#

== Return Value

* True if the pointer may be captured before `I.`
* Capture components that may be captured on the path to `I.`

== Parameters

[cols="1,4"]
|===
| Name| Description
| *V*
| Pointer value whose captures are queried.
| *ReturnCaptures*
| Whether returning the value (or part of it) counts as capturing it.
| *I*
| Instruction before which captures are considered.
| *DT*
| Optional dominator tree used to restrict captures to those before `I.`
| *IncludeI*
| Whether captures by `I` itself are considered.
| *MaxUsesToExplore*
| How many uses to explore before giving up; zero means use the default.
| *LI*
| Optional loop info used to prune reachability checks.
| *Mask*
| Capture components to consider.
| *StopFn*
| Predicate that aborts traversal when it returns true on the accumulated components.
|===


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