[#BloombergLP-bdlmt-MultiQueueThreadPool_Queue-initiatePause]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlmt.adoc[bdlmt]::xref:BloombergLP/bdlmt/MultiQueueThreadPool_Queue.adoc[MultiQueueThreadPool_Queue]::initiatePause
:relfileprefix: ../../../
:mrdocs:

Initiate the pausing of this queue, prevent jobs from being executed on this queue (excluding the currently‐executing job ‐ or batch of jobs ‐ if there is one), and prevent the queue from being deleted. Return 0 on success, and a non‐zero value if the queue is already paused or is being paused or deleted by another thread. The behavior is undefined unless, after a successful invocation of `initiatePause`, `waitWhilePausing` is invoked (to complete the pause operation and allow the queue to, potentially, be deleted).

== Synopsis

Declared in `<bdlmt_multiqueuethreadpool.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
initiatePause();
----


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