externalLibs/Carbon/Carbon/MSMQ/Test-MsmqMessageQueue.ps1
|
# Copyright 2012 Aaron Jensen # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. function Test-MsmqMessageQueue { <# .SYNOPSIS Tests if an MSMQ message queue exists. .DESCRIPTION Returns `True` if a message queue with name `Name` exists. `False` otherwise. .OUTPUTS System.Boolean. .EXAMPLE Test-MsmqMessageQueue -Name 'MovieQueue' Returns `True` if public queue `MovieQueue` exists, `False` otherwise. .EXAMPLE Test-MsmqMessageQueue -Name 'MovieCriticsQueue' -Private Returns `True` if private queue `MovieCriticsQueue` exists, `False` otherwise. #> [CmdletBinding()] param( [Parameter(Mandatory=$true)] [string] # The queue name. $Name, [Switch] # If the queue is private, this switch must be set. $Private ) $queueArgs = @{ Name = $Name ; Private = $Private } $path = Get-MsmqMessageQueuePath @queueArgs return ( [Messaging.MessageQueue]::Exists( $path ) ) } |