MsmqElementBase.DeadLetterQueue Property

Definition

Namespace:

System.ServiceModel.Configuration

Assembly:

System.ServiceModel.dll

Gets or sets an enumeration value that indicates the type of dead-letter queue to use.

public:
 property System::ServiceModel::DeadLetterQueue DeadLetterQueue { System::ServiceModel::DeadLetterQueue get(); void set(System::ServiceModel::DeadLetterQueue value); };

[System.Configuration.ConfigurationProperty("deadLetterQueue", DefaultValue=System.ServiceModel.DeadLetterQueue.System)]
public System.ServiceModel.DeadLetterQueue DeadLetterQueue { get; set; }

[<System.Configuration.ConfigurationProperty("deadLetterQueue", DefaultValue=System.ServiceModel.DeadLetterQueue.System)>]
member this.DeadLetterQueue : System.ServiceModel.DeadLetterQueue with get, set

Public Property DeadLetterQueue As DeadLetterQueue

Property Value

DeadLetterQueue

A DeadLetterQueue enumeration value that indicates the type of dead-letter queue to use.

Attributes

ConfigurationPropertyAttribute

Remarks

The dead-letter queue is a queue on the queue manager of the sending application for expired messages that have failed to be delivered. The dead-letter queue enumeration specifies the type of dead-letter queue to use. The values are:

• None: If no dead-letter queue is required. Thus, if a message were to fail delivery, no record of it would be maintained in the dead-letter queue. This is the default value when ExactlyOnce is set to false.

• System: The system-wide dead-letter queue would be used to record messages that fail delivery. Message Queuing (also known as MSMQ) has a transactional system dead-letter queue and a nontransactional system dead-letter queue to record messages that failed delivery from transactional and nontransactional queues, respectively. This is the default value when ExactlyOnce is set to true.

• Custom: The queue specified in the CustomDeadLetterQueue is used to record messages that fail delivery.

The reasons that a message can fail to reach the receiving application include:

• A transactional message is sent to a nontransactional queue.

• A nontransactional message is sent to a transactional queue.

• An unauthenticated message is sent to a queue that accepts only authenticated messages.

• An unencrypted message is sent to a queue that accepts only encrypted messages.

• The message expires before the message is delivered to a receiver.

• The message storage quota of the target computer or the storage quota of the destination queue is exceeded, or there is no available storage space on the target computer when the message arrives.

• The sender does not have the access rights needed to place the message in the destination queue.

• The digital signature attached to the message is not valid.

• An encrypted message cannot be decrypted by the destination queue manager.

• The destination queue is purged or deleted before the message is retrieved.