MessagePropertyFilter.UseDeadLetterQueue Property

  • Reference

Definition

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

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

public:
 property bool UseDeadLetterQueue { bool get(); void set(bool value); };
[System.Messaging.MessagingDescription("MsgUseDeadLetterQueue")]
public bool UseDeadLetterQueue { get; set; }
[<System.Messaging.MessagingDescription("MsgUseDeadLetterQueue")>]
member this.UseDeadLetterQueue : bool with get, set
Public Property UseDeadLetterQueue As Boolean

Property Value

Boolean

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

Attributes
MessagingDescriptionAttribute

Examples

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

// Set the queue's MessageReadPropertyFilter property 
// to enable the message's UseDeadLetterQueue property.
queue->MessageReadPropertyFilter->
    UseDeadLetterQueue = 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 
// UseDeadLetterQueue property.
Console::WriteLine("Message.UseDeadLetterQueue: {0}", 
    orderMessage->UseDeadLetterQueue);

// Set the queue's MessageReadPropertyFilter property to enable the
// message's UseDeadLetterQueue property.
queue.MessageReadPropertyFilter.UseDeadLetterQueue = 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 UseDeadLetterQueue property.
Console.WriteLine("Message.UseDeadLetterQueue: {0}",
    orderMessage.UseDeadLetterQueue);

Remarks

The UseDeadLetterQueue property of the Message class specifies whether a copy of a message that could not be delivered should be sent to a dead-letter queue.

Applies to

See also