Edit

Share via


Message.UseDeadLetterQueue Property

Definition

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.

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

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.

Attributes

Exceptions

The message queue is filtered to ignore the UseDeadLetterQueue property.

Examples

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

Remarks

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.

Applies to

See also