Clear-MsmqQueue
Clear-MsmqQueue
This cmdlet purges all queues that are represented by the supplied MessageQueue objects.
Syntax
Parameter Set: Default
Clear-MsmqQueue -InputObject <MessageQueue[]> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
This cmdlet purges all queues that are represented by the supplied MessageQueue objects. It returns a MessageQueue object that represents the cleared outgoing queue.
Parameters
-InputObject<MessageQueue[]>
A MessageQueue object that represents a queue that will be purged. Accepts pipelined input.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByValue) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Usage Scenario
PS C:\> Get-MessageQueue –Name Order* | Clear-MessageQueue