[#BloombergLP-bdlmt-MultiQueueThreadPool-deleteQueue-0a]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlmt.adoc[bdlmt]::xref:BloombergLP/bdlmt/MultiQueueThreadPool.adoc[MultiQueueThreadPool]::deleteQueue
:relfileprefix: ../../../
:mrdocs:

Delete the queue with the specified `id` after its current job finishes.

== Synopsis

Declared in `<bdlmt_multiqueuethreadpool.h>`

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

== Description

Disable enqueuing to the queue associated with the specified `id`, and when the currently executing job (or batch of jobs) of that queue, if any, is complete, then destroy the queue. Return 0 on success, and a non‐zero value otherwise. This function will fail if the pool is stopped. Any other (non‐executing) jobs on the queue are deleted asynchronously. The calling thread blocks until completion of the currently executing job (or batch of jobs), except when `deleteQueue` is called from a job in the queue being deleted. In that latter case, no block takes place, the queue is deleted (no longer observable from the `MultiQueueThreadPool`), and the job completes.

== Return Value

0 on success, and a non‐zero value otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *id*
| queue identifier
|===


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