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

Check a function for errors, useful for use when debugging a pass.

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
bool
verifyFunction(
    xref:llvm/Function.adoc[Function] const& F,
    xref:llvm/raw_ostream.adoc[raw_ostream]* OS = nullptr);
----

== Description

If there are no errors, the function returns false. If an error is found, a message describing the error is written to OS (if non‐null) and true is returned.

== Return Value

True if the function is broken; false otherwise.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *F*
| Function whose IR is verified.
| *OS*
| Optional stream that receives a description of any error found.
|===


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