Export (0) Print
Expand All

MessagePropertyFilter.TimeToBeReceived Property

Gets or sets a value that indicates whether to retrieve Message.TimeToBeReceived property information when receiving or peeking a message.

Namespace:  System.Messaging
Assembly:  System.Messaging (in System.Messaging.dll)

public bool TimeToBeReceived { get; set; }

Property Value

Type: System.Boolean
true to receive Message.TimeToBeReceived information; otherwise, false. The default is false.

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.

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}",

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

© 2014 Microsoft