[#StdMutex-CheckNotHeld]
= xref:StdMutex.adoc[StdMutex]::CheckNotHeld
:relfileprefix: ../
:mrdocs:

Assert (for the analyzer) that a mutex is not currently held and return it.

== Synopsis

Declared in `<util/stdmutex.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[requires_capability(0x7f2e35e5b418), lock_returned(cs), requires_capability(0x7f2e439ab888)]]
static
xref:StdMutex.adoc[StdMutex]&
CheckNotHeld(xref:StdMutex.adoc[StdMutex]& cs);
----

== Return Value

The same mutex reference, so callers can lock it.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *cs*
| The mutex that must not be held.
|===


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