MQDeleteQueue
A version of this page is also available for
4/8/2010
This function deletes a queue from the local computer.
Syntax
HRESULT APIENTRY MQDeleteQueue(
LPCWSTR lpwcsFormatName
);
Parameters
- lpwcsFormatName
[in] Pointer to the direct format name string of the queue to be deleted.
Return Value
- MQ_OK
Indicates success.
MQ_ERROR_ACCESS_DENIED
The process does not have the access rights to delete this queue.To change access rights, call MQSetQueueSecurity.
- MQ_ERROR_ILLEGAL_FORMATNAME
The specified format name in lpwcsFormatName is illegal.
- MQ_ERROR_SERVICE_NOT_AVAILABLE
Cannot connect to the Queue Manager.
MQ_ERROR_UNSUPPORTED_FORMATNAME_OPERATION
The format name specified by lpwcsFormatName cannot be used to delete a queue.You cannot reference a queue using a direct format name, nor can you delete a journal, dead-letter, or connector queue.
Remarks
All queues must be referenced using a private format name.
MSMQ must be able to access the local computer to delete private queues.
Private queues registered on a remote computer, as well as journal, dead-letter, and connector queues cannot be deleted.
Note
OS versions prior to 2.12 require the MSMQ add-on pack.
Requirements
| Header | mq.h |
| Library | msmqrt.lib |
| Windows Embedded CE | Windows CE 2.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |
| Note | Versions prior to 2.12 require the MSMQ add-on pack |