TimeToBeReceived Property (Message)

Gets or sets the maximum amount of time for the message to be received from the destination queue.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ReadOnlyAttribute(True)>
<DesignerSerializationVisibilityAttribute(DesignerSerializationVisibility.Hidden)>
<TypeConverterAttribute("System.Messaging.Design.TimeoutConverter, System.Messaging, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>
<MessagingDescriptionAttribute("Specifies the total time (in seconds) the message is allowed to live. Use "Infinity" to set the maximum value.")>
Public Property TimeToBeReceived As TimeSpan

'Usage
 
Dim instance As Message
Dim value As TimeSpan
 
instance.TimeToBeReceived = value
 
value = instance.TimeToBeReceived

[ReadOnly(true)]
[DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
[TypeConverter("System.Messaging.Design.TimeoutConverter, System.Messaging, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]
[MessagingDescription("Specifies the total time (in seconds) the message is allowed to live. Use "Infinity" to set the maximum value.")]
public TimeSpan TimeToBeReceived {get; set;}

[ReadOnly(true)]
[DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
[TypeConverter("System.Messaging.Design.TimeoutConverter, System.Messaging, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]
[MessagingDescription("Specifies the total time (in seconds) the message is allowed to live. Use "Infinity" to set the maximum value.")]
public:
property TimeSpan TimeToBeReceived {
   TimeSpan get();
   void set (    TimeSpan value);
}

Property Value

The total time for a sent message to be received from the destination queue. The default is InfiniteTimeout.

Exceptions

Exception	Description
System.InvalidOperationException	The message queue is filtered to ignore the TimeToBeReceived property.
System.ArgumentException	The value specified for TimeToBeReceived is invalid.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

Message Class
Message Members