Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Clear-MsmqQueue

Last Updated: 3/8/2017

SYNOPSIS

Clears queues.

SYNTAX

Clear-MsmqQueue -InputObject <MessageQueue[]> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

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

EXAMPLES

Example 1: Clear message queues based on name

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

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

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InputObject

Specifies an array of MessageQueue objects. This cmdlet clears the queues that the MessageQueue objects specify. This parameter accepts pipeline input.

Type: MessageQueue[]
Parameter Sets: (All)
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Get-MsmqQueue

New-MsmqQueue

Receive-MsmqQueue

Remove-MsmqQueue

Send-MsmqQueue

Set-MsmqQueue

© 2017 Microsoft