Export (0) Print
Expand All

MessageQueue.BasePriority Property

Gets or sets the base priority Message Queuing uses to route a public queue's messages over the network.

Namespace:  System.Messaging
Assembly:  System.Messaging (in System.Messaging.dll)

[MessagingDescriptionAttribute("MQ_BasePriority")]
public short BasePriority { get; set; }

Property Value

Type: System.Int16
The single base priority for all messages sent to the (public) queue. The default is zero (0).

ExceptionCondition
ArgumentException

The base priority was set to an invalid value.

MessageQueueException

An error occurred when accessing a Message Queuing method.

A message queue's base priority specifies how a message en route to that queue is treated as it travels through the network. You can set the BasePriority property to confer a higher or lower priority to all messages sent to the specified queue than those sent to other queues. Setting this property modifies the Message Queuing queue. Therefore, any other MessageQueue instances are affected by the change.

A message queue's BasePriority is not related to the Priority property of a message, which specifies the order in which an incoming message is placed in the queue.

BasePriority applies only to public queues whose paths are specified using the format name. The base priority of a private queue is always zero (0).

The following table shows whether this property is available in various Workgroup modes.

Workgroup mode

Available

Local computer

Yes

Local computer and direct format name

Yes

Remote computer

No

Remote computer and direct format name

No

The following code example gets and sets the value of a message queue's BasePriority property.

// Set the queue's BasePriority property value.
queue.BasePriority = 10;

// Display the new value of the queue's BasePriority property.
Console.WriteLine("MessageQueue.BasePriority: {0}", queue.BasePriority);

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft