MessageQueue.MaximumQueueSize Property

  • Reference

Definition

Namespace:
System.Messaging
Assembly:
System.Messaging.dll

Gets or sets the maximum size of the queue.

public:
 property long MaximumQueueSize { long get(); void set(long value); };
[System.ComponentModel.TypeConverter(typeof(System.Messaging.Design.SizeConverter))]
[System.Messaging.MessagingDescription("MQ_MaximumQueueSize")]
public long MaximumQueueSize { get; set; }
[<System.ComponentModel.TypeConverter(typeof(System.Messaging.Design.SizeConverter))>]
[<System.Messaging.MessagingDescription("MQ_MaximumQueueSize")>]
member this.MaximumQueueSize : int64 with get, set
Public Property MaximumQueueSize As Long

Property Value

Int64

The maximum size, in kilobytes, of the queue. The Message Queuing default specifies that no limit exists.

Attributes
TypeConverterAttribute MessagingDescriptionAttribute

Exceptions

ArgumentException

The maximum queue size contains a negative value.

MessageQueueException

An error occurred when accessing a Message Queuing method.

Examples

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

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

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

Remarks

The MaximumQueueSize provides access to the Message Queuing message storage limit, which is separate from the computer's message quota that the administrator defines. For more information about the message quota, see MaximumJournalSize.

Setting this property modifies the Message Queuing queue. Therefore, any other MessageQueue instances are affected by the change

If an attempt is made to exceed either the maximum queue size or the computer message quota, messages might be lost. When the queue quota is reached, Message Queuing notifies the administration queue of the sending application to indicate that the queue is full, by returning a negative acknowledgment message. Message Queuing continues to send negative acknowledgments until the total size of the messages in the queue drops below the limit.

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