Clear-Msmq Outgoing Queue

Module:
msmq
Clears outgoing queues.

Syntax 

Clear-MsmqOutgoingQueue
     -InputObject <OutgoingQueue[]>
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

The Clear-MsmqOutgoingQueue cmdlet clears outgoing queues. Specify queues to clear by using MsmqOutgoingQueue objects. This cmdlet returns an MsmqOutgoingQueue object that represents the cleared outgoing queue.

Examples

Example 1: Clear outgoing message queues based on name 

PS C:\> Get-MsmqOutgoingQueue -Name "Order*" | Clear-MsmqOutgoingQueue

This command gets all the outgoing message queues that have names that start with the string Order by using the Get-MsmqOutgoingQueue cmdlet. The command passes the results to the current cmdlet by using the pipeline operator. The current cmdlet clears each queue.

Required Parameters

-InputObject

Specifies an array of MsmqOutgoingQueue objects. This cmdlet clears outgoing queues that this parameter specifies. This parameter accepts pipeline input.

Type: OutgoingQueue[]
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Aliases: cf
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Aliases: wi
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False