This topic has not yet been rated - Rate this topic

MessageQueue.BasePriority Property

.NET Framework 4

Other Versions

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)

Syntax

C++

Copy

[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).

Exceptions

Exception	Condition
ArgumentException	The base priority was set to an invalid value.
MessageQueueException	An error occurred when accessing a Message Queuing method.

Remarks

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

Examples

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

Copy


// 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);

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET Framework Security

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.

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Reference

MessageQueue Class

System.Messaging Namespace

FormatName

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ