MessagePropertyFilter.Recoverable Property
Definition
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 Recoverable property information when receiving or peeking a message.
public:
property bool Recoverable { bool get(); void set(bool value); };[System.Messaging.MessagingDescription("MsgRecoverable")]
public bool Recoverable { get; set; }[<System.Messaging.MessagingDescription("MsgRecoverable")>]
member this.Recoverable : bool with get, setPublic Property Recoverable As BooleanProperty Value
true to receive Recoverable information; otherwise, false. The default is false.
- Attributes
Examples
The following code example demonstrates the use of the Recoverable property.
// Set the queue's MessageReadPropertyFilter property
// to enable the message's Recoverable property.
queue->MessageReadPropertyFilter->Recoverable = 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
// Recoverable property.
Console::WriteLine("Message.Recoverable: {0}",
orderMessage->Recoverable);
// Set the queue's MessageReadPropertyFilter property to enable the
// message's Recoverable property.
queue.MessageReadPropertyFilter.Recoverable = 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 Recoverable property.
Console.WriteLine("Message.Recoverable: {0}",
orderMessage.Recoverable);
Remarks
The Recoverable property of the Message class indicates whether delivery of a message is guaranteed, even if a computer crashes while the message is en route to the destination queue.
If delivery of a message is guaranteed, the message is stored locally at every step until the message is successfully forwarded to the next computer. Setting Message.Recoverable to true on the message could affect the throughput.
