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

A nullable Value handle that is nullable.

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class WeakVH
    : public xref:llvm/ValueHandleBase.adoc[ValueHandleBase]
----

== Description

This is a value handle that points to a value, and nulls itself out if that value is deleted.

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:llvm/ValueHandleBase.adoc[ValueHandleBase]`
| Befriended by DenseMapBase so it can use bucket‐relocation erase callbacks. ValueHandleBase is the only caller that caches pointers into bucket arrays.
|===

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/WeakVH/2constructor-0ff.adoc[`WeakVH`]         [.small]#[constructor]#
| Constructors
| xref:llvm/WeakVH/operator_assign-00.adoc[`operator=`] 
| Assignment operators
| xref:llvm/ValueHandleBase/operator_star.adoc[`operator*`] 
| Return a reference to the tracked Value.
| xref:llvm/ValueHandleBase/operator_ptr.adoc[`operator‐>`] 
| Return a pointer to the tracked Value.
| xref:llvm/WeakVH/2conversion.adoc[`operator Value*`] 
| Implicit conversion to the tracked Value pointer.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/ValueHandleBase/ValueIsDeleted.adoc[`ValueIsDeleted`] 
| Notify all handles that `V` is being destroyed.
| xref:llvm/ValueHandleBase/ValueIsRAUWd.adoc[`ValueIsRAUWd`] 
| Notify all handles that `Old` is being RAUW'd to `New.`
|===


== Protected Enums

[cols="1,4"]
|===
| Name| Description
| xref:llvm/ValueHandleBase/HandleBaseKind.adoc[`HandleBaseKind`] 
| This indicates what sub class the handle actually is.
|===


== Protected Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/ValueHandleBase/RemoveFromUseList.adoc[`RemoveFromUseList`] 
| Remove this ValueHandle from its current use list.
| xref:llvm/ValueHandleBase/clearValPtr.adoc[`clearValPtr`] 
| Clear the underlying pointer without clearing the use list.
| xref:llvm/ValueHandleBase/getValPtr.adoc[`getValPtr`] 
| Return the raw Value pointer held by this handle.
|===


== Protected Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/ValueHandleBase/isValid.adoc[`isValid`] 
| Return true if `V` is a non‐null Value pointer.
|===



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