[#BloombergLP-bslstl-StopState-stopRequested]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslstl.adoc[bslstl]::xref:BloombergLP/bslstl/StopState.adoc[StopState]::stopRequested
:relfileprefix: ../../../
:mrdocs:

Return `true` if a stop has been requested on this `StopState` object, and `false` otherwise.

== Synopsis

Declared in `<bslstl_stopstate.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[nodiscard]]
bool
stopRequested() const;
----

== Return Value

[NOTE]
====
The return value https://en.cppreference.com/cpp/language/attributes/nodiscard[should not be discarded^].
====

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