Export (0) Print
Expand All

WebRequest::Timeout Property

Gets or sets the length of time, in milliseconds, before the request times out.

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

public:
virtual property int Timeout {
	int get ();
	void set (int value);
}

Property Value

Type: System::Int32
The length of time, in milliseconds, until the request times out, or the value Timeout::Infinite to indicate that the request does not time out. The default value is defined by the descendant class.

ExceptionCondition
NotImplementedException

Any attempt is made to get or set the property, when the property is not overridden in a descendant class.

The Timeout property indicates the length of time, in milliseconds, until the request times out and throws a WebException. The Timeout property affects only synchronous requests made with the GetResponse method. To time out asynchronous requests, use the Abort method.

NoteNote:

The WebRequest class is an abstract class. The actual behavior of WebRequest instances at run time is determined by the descendant class returned by the WebRequest::Create method. For more information about default values and exceptions, see the documentation for the descendant classes, such as HttpWebRequest and FileWebRequest.

Notes to Inheritors:

Descendant classes signal a timeout by throwing a WebException with the Status field set to WebExceptionStatus::Timeout. When Timeout is set to Timeout::Infinite the descendant class does not time out.

The following example sets the Timeout property to 10000 milliseconds. If the timeout period expires before the resource can be returned, a WebException is thrown.

// Create a new WebRequest Object to the mentioned URL.
WebRequest^ myWebRequest = WebRequest::Create( "http://www.contoso.com" );
Console::WriteLine( "\nThe Timeout time of the request before setting is : {0} milliseconds", myWebRequest->Timeout );

// Set the 'Timeout' property in Milliseconds.
myWebRequest->Timeout = 10000;

// This request will throw a WebException if it reaches the timeout limit 
// before it is able to fetch the resource.
WebResponse^ myWebResponse = myWebRequest->GetResponse();
// Create a new WebRequest Object to the mentioned URL.
WebRequest* myWebRequest = WebRequest::Create(S"http://www.contoso.com");
Console::WriteLine(S"\nThe Timeout time of the request before setting is : {0} milliseconds", 
   __box(myWebRequest->Timeout));

// Set the 'Timeout' property in Milliseconds.
myWebRequest->Timeout=10000;

// This request will throw a WebException if it reaches the timeout limit
// before it is able to fetch the resource.
WebResponse* myWebResponse = myWebRequest->GetResponse();

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

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

.NET Framework

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

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft