MessageQueue.BasePriority Property

Definition

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

public:
 property short BasePriority { short get(); void set(short value); };
[System.Messaging.MessagingDescription("MQ_BasePriority")]
public short BasePriority { get; set; }
[<System.Messaging.MessagingDescription("MQ_BasePriority")>]
member this.BasePriority : int16 with get, set
Public Property BasePriority As Short

Property Value

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

Attributes

Exceptions

The base priority was set to an invalid value.

An error occurred when accessing a Message Queuing method.

Examples

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

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

Applies to

See also