MessagePropertyFilter.TimeToReachQueue Property

Reference

Definition

Namespace:: System.Messaging

Assembly:: System.Messaging.dll

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 TimeToReachQueue property information when receiving or peeking a message.

public:
 property bool TimeToReachQueue { bool get(); void set(bool value); };

[System.Messaging.MessagingDescription("MsgTimeToReachQueue")]
public bool TimeToReachQueue { get; set; }

[<System.Messaging.MessagingDescription("MsgTimeToReachQueue")>]
member this.TimeToReachQueue : bool with get, set

Public Property TimeToReachQueue As Boolean

Property Value

Boolean

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

Attributes: MessagingDescriptionAttribute

Examples

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

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

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

Remarks

The TimeToReachQueue property of the Message class specifies a time limit in seconds from the time the message is sent for it to reach the destination queue.

Applies to

Share via