Export (0) Print
Expand All

Message.UseDeadLetterQueue Property

Gets or sets a value that indicates whether a copy of the message that could not be delivered should be sent to a dead-letter queue.

Namespace:  System.Messaging
Assembly:  System.Messaging (in System.Messaging.dll)

[MessagingDescriptionAttribute("MsgUseDeadLetterQueue")]
public bool UseDeadLetterQueue { get; set; }

Property Value

Type: System.Boolean
true if message-delivery failure should result in a copy of the message being sent to a dead-letter queue; otherwise, false. The default is false.

ExceptionCondition
InvalidOperationException

The message queue is filtered to ignore the UseDeadLetterQueue property.

The UseJournalQueue and UseDeadLetterQueue properties specify how Message Queuing tracks a message. If UseDeadLetterQueue is true, delivery failure (of a non-transactional message), causes the message to be sent to the non-transactional dead-letter queue on the computer that could not deliver the message. Delivery failure could be caused by a message timer expiring, for example.

In the case of delivery failure for a transactional message, Message Queuing sends the message to the transactional dead-letter queue on the source machine in all negative and in-doubt cases.

When you store messages in a dead-letter queue, you should clear the queue periodically to remove messages that are no longer needed. Messages stored in dead-letter queues count against the size quota for the computer where the queue resides. The computer quota is set by the administrator and refers to the size allocated for storing messages on the whole computer, not just in a single queue.

You do not create a journal or dead-letter queue. These are both system queues that Message Queuing generates.

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

// Set the message's UseDeadLetterQueue property.
orderMessage.UseDeadLetterQueue = true;

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

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft