MessagePropertyFilter.AdministrationQueue Property

Reference

Definition

Namespace:: System.Messaging

Assembly:: System.Messaging.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets a value that indicates whether to retrieve AdministrationQueue property information when receiving or peeking a message.

public:
 property bool AdministrationQueue { bool get(); void set(bool value); };

[System.Messaging.MessagingDescription("MsgAdministrationQueue")]
public bool AdministrationQueue { get; set; }

[<System.Messaging.MessagingDescription("MsgAdministrationQueue")>]
member this.AdministrationQueue : bool with get, set

Public Property AdministrationQueue As Boolean

Property Value

Boolean

true to receive AdministrationQueue information; otherwise, false. The default is true.

Attributes: MessagingDescriptionAttribute

Examples

The following code example demonstrates the use of the AdministrationQueue property.

// Set the queue's MessageReadPropertyFilter property 
// to enable the message's AdministrationQueue property.
queue->MessageReadPropertyFilter->
    AdministrationQueue = true;

// Peek at the message. Time out after ten seconds 
// in case the message was not delivered.
orderMessage = queue->Peek(TimeSpan::FromSeconds(10.0));

// Display the value of the message's 
// AdministrationQueue property.
Console::WriteLine("Message.AdministrationQueue: {0}", 
    orderMessage->AdministrationQueue);

// Set the queue's MessageReadPropertyFilter property to enable the
// message's AdministrationQueue property.
queue.MessageReadPropertyFilter.AdministrationQueue = true;

// Peek at the message. Time out after ten seconds in case the message
// was not delivered.
orderMessage = queue.Peek(TimeSpan.FromSeconds(10.0));

// Display the value of the message's AdministrationQueue property.
Console.WriteLine("Message.AdministrationQueue: {0}",
    orderMessage.AdministrationQueue);

Remarks

The AdministrationQueue property of the Message class specifies the name of the queue that receives system-generated acknowledgments.

Applies to

Share via