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

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

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

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

Public Property TimeToBeReceived As Boolean

Property Value

Boolean

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

Attributes: MessagingDescriptionAttribute

Examples

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

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

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

Remarks

The TimeToBeReceived property of the Message class specifies the total time in seconds for a sent message to be received from the destination queue. The time limit for the message to be retrieved from the target queue includes the time spent getting to the destination queue, plus the time spent waiting in the queue before the message is retrieved by an application.

Applies to

Jaa