MessageQueue.GetPublicQueuesByMachine Method
Retrieves all the public queues that reside on the specified computer.
Assembly: System.Messaging (in System.Messaging.dll)
'Declaration Public Shared Function GetPublicQueuesByMachine ( _ machineName As String _ ) As MessageQueue() 'Usage Dim machineName As String Dim returnValue As MessageQueue() returnValue = MessageQueue.GetPublicQueuesByMachine(machineName)
Parameters
- machineName
- Type: System.String
The name of the computer that contains the set of public queues to be retrieved.
Return Value
Type: System.Messaging.MessageQueue()An array of MessageQueue objects that reference the public queues on the computer.
| Exception | Condition |
|---|---|
| ArgumentException | The machineName parameter has incorrect syntax. |
| MessageQueueException | An error occurred when accessing a Message Queuing method. |
Use this method to filter the public queues by computer.
GetPublicQueuesByMachine(String) retrieves a static snapshot of the queues. To interact with a dynamic list of the queues, use GetMessageQueueEnumerator. You can specify the computer name as part of the MessageQueueCriteria you pass into the method.
The following table shows whether this method is available in various Workgroup modes.
Workgroup mode | Available |
|---|---|
Local computer | No |
Local computer and direct format name | No |
Remote computer | No |
Remote computer and direct format name | No |
The following code example retrieves lists of queues.
Imports System Imports System.Messaging Public Class MyNewQueue ' Provides an entry point into the application. ' ' This example gets lists of queues by a variety ' of criteria. Public Shared Sub Main() ' Create a new instance of the class. Dim myNewQueue As New MyNewQueue() ' Send normal and high priority messages. myNewQueue.GetQueuesByCategory() myNewQueue.GetQueuesByLabel() myNewQueue.GetQueuesByComputer() myNewQueue.GetAllPublicQueues() myNewQueue.GetPublicQueuesByCriteria() myNewQueue.GetPrivateQueues() Return End Sub 'Main ' Gets a list of queues with a specified category. ' Sends a broadcast message to all queues in that ' category. Public Sub GetQueuesByCategory() ' Get a list of queues with the specified category. Dim QueueList As MessageQueue() = _ MessageQueue.GetPublicQueuesByCategory(New _ Guid("{00000000-0000-0000-0000-000000000001}")) ' Send a broadcast message to each queue in the array. Dim queueItem As MessageQueue For Each queueItem In QueueList queueItem.Send("Broadcast message.") Next queueItem Return End Sub 'GetQueuesByCategory ' Gets a list of queues with a specified label. ' Sends a broadcast message to all queues with that ' label. Public Sub GetQueuesByLabel() ' Get a list of queues with the specified label. Dim QueueList As MessageQueue() = _ MessageQueue.GetPublicQueuesByLabel("My Label") ' Send a broadcast message to each queue in the array. Dim queueItem As MessageQueue For Each queueItem In QueueList queueItem.Send("Broadcast message.") Next queueItem Return End Sub 'GetQueuesByLabel ' Gets a list of queues on a specified computer. ' Displays the list on screen. Public Sub GetQueuesByComputer() ' Get a list of queues on the specified computer. Dim QueueList As MessageQueue() = _ MessageQueue.GetPublicQueuesByMachine("MyComputer") ' Display the paths of the queues in the list. Dim queueItem As MessageQueue For Each queueItem In QueueList Console.WriteLine(queueItem.Path) Next queueItem Return End Sub 'GetQueuesByComputer ' Gets a list of all public queues. Public Sub GetAllPublicQueues() ' Get a list of public queues. Dim QueueList As MessageQueue() = _ MessageQueue.GetPublicQueues() Return End Sub 'GetAllPublicQueues ' Gets a list of all public queues that match ' specified criteria. Displays the list on ' screen. Public Sub GetPublicQueuesByCriteria() ' Define criteria to filter the queues. Dim myCriteria As New MessageQueueCriteria() myCriteria.CreatedAfter = DateTime.Now.Subtract(New _ TimeSpan(1, 0, 0, 0)) myCriteria.ModifiedBefore = DateTime.Now myCriteria.MachineName = "." myCriteria.Label = "My Queue" ' Get a list of queues with that criteria. Dim QueueList As MessageQueue() = _ MessageQueue.GetPublicQueues(myCriteria) ' Display the paths of the queues in the list. Dim queueItem As MessageQueue For Each queueItem In QueueList Console.WriteLine(queueItem.Path) Next queueItem Return End Sub 'GetPublicQueuesByCriteria ' Gets a list of private queues on the local ' computer. Displays the list on screen. Public Sub GetPrivateQueues() ' Get a list of queues with the specified category. Dim QueueList As MessageQueue() = _ MessageQueue.GetPrivateQueuesByMachine(".") ' Display the paths of the queues in the list. Dim queueItem As MessageQueue For Each queueItem In QueueList Console.WriteLine(queueItem.Path) Next queueItem Return End Sub 'GetPrivateQueues End Class 'MyNewQueue
#using <mscorlib.dll>
#using <system.dll>
#using <system.messaging.dll>
using namespace System;
using namespace System::Messaging;
using namespace System::Collections;
__gc class MyNewQueue
{
// Gets a list of queues with a specified category.
// Sends a broadcast message to all queues in that
// category.
public:
void GetQueuesByCategory()
{
// Get a list of queues with the specified category.
MessageQueue* QueueList[] =
MessageQueue::GetPublicQueuesByCategory(
Guid(S" {00000000-0000-0000-0000-000000000001}"));
// Send a broadcast message to each queue in the array.
IEnumerator* myEnum = QueueList->GetEnumerator();
while (myEnum->MoveNext())
{
MessageQueue* queueItem = __try_cast<MessageQueue*>(myEnum->Current);
queueItem->Send(S"Broadcast message.");
}
return;
}
// Gets a list of queues with a specified label.
// Sends a broadcast message to all queues with that
// label.
public:
void GetQueuesByLabel()
{
// Get a list of queues with the specified label.
MessageQueue* QueueList[] =
MessageQueue::GetPublicQueuesByLabel(S"My Label");
// Send a broadcast message to each queue in the array.
IEnumerator* myEnum = QueueList->GetEnumerator();
while (myEnum->MoveNext())
{
MessageQueue* queueItem = __try_cast<MessageQueue*>(myEnum->Current);
queueItem->Send(S"Broadcast message.");
}
return;
}
// Gets a list of queues on a specified computer.
// Displays the list on screen.
public:
void GetQueuesByComputer()
{
// Get a list of queues on the specified computer.
MessageQueue* QueueList[] =
MessageQueue::GetPublicQueuesByMachine(S"MyComputer");
// Display the paths of the queues in the list.
IEnumerator* myEnum = QueueList->GetEnumerator();
while (myEnum->MoveNext())
{
MessageQueue* queueItem = __try_cast<MessageQueue*>(myEnum->Current);
Console::WriteLine(queueItem->Path);
}
return;
}
// Gets a list of all public queues.
public:
void GetAllPublicQueues()
{
// Get a list of public queues.
MessageQueue* QueueList[] = MessageQueue::GetPublicQueues();
return;
}
// Gets a list of all public queues that match
// specified criteria. Displays the list on
// screen.
public:
void GetPublicQueuesByCriteria()
{
// Define criteria to filter the queues.
MessageQueueCriteria* myCriteria = new MessageQueueCriteria();
myCriteria->CreatedAfter = DateTime::Now.Subtract(TimeSpan(1, 0, 0, 0));
myCriteria->ModifiedBefore = DateTime::Now;
myCriteria->MachineName = S".";
myCriteria->Label = S"My Queue";
// Get a list of queues with that criteria.
MessageQueue* QueueList[] =
MessageQueue::GetPublicQueues(myCriteria);
// Display the paths of the queues in the list.
IEnumerator* myEnum = QueueList->GetEnumerator();
while (myEnum->MoveNext())
{
MessageQueue* queueItem = __try_cast<MessageQueue*>(myEnum->Current);
Console::WriteLine(queueItem->Path);
}
return;
}
// Gets a list of private queues on the local
// computer. Displays the list on screen.
public:
void GetPrivateQueues()
{
// Get a list of queues with the specified category.
MessageQueue* QueueList[] =
MessageQueue::GetPrivateQueuesByMachine(S".");
// Display the paths of the queues in the list.
IEnumerator* myEnum = QueueList->GetEnumerator();
while (myEnum->MoveNext())
{
MessageQueue* queueItem = __try_cast<MessageQueue*>(myEnum->Current);
Console::WriteLine(queueItem->Path);
}
return;
}
};
// Provides an entry point into the application.
// This example gets lists of queues by a variety
// of criteria.
int main()
{
// Create a new instance of the class.
MyNewQueue* myNewQueue = new MyNewQueue();
// Send normal and high priority messages.
myNewQueue->GetQueuesByCategory();
myNewQueue->GetQueuesByLabel();
myNewQueue->GetQueuesByComputer();
myNewQueue->GetAllPublicQueues();
myNewQueue->GetPublicQueuesByCriteria();
myNewQueue->GetPrivateQueues();
return 0;
}
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.