WebException Class

.NET Framework (current version)

Other Versions

The exception that is thrown when an error occurs while accessing the network through a pluggable protocol.

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

Inheritance Hierarchy

System::Object
System::Exception
System::SystemException
System::InvalidOperationException
System.Net::WebException

Syntax

C++

[SerializableAttribute]
public ref class WebException : InvalidOperationException, ISerializable

Constructors

	Name	Description
	WebException()	Initializes a new instance of the WebException class.
	WebException(SerializationInfo^, StreamingContext)	Initializes a new instance of the WebException class from the specified SerializationInfo and StreamingContext instances.
	WebException(String^)	Initializes a new instance of the WebException class with the specified error message.
	WebException(String^, Exception^)	Initializes a new instance of the WebException class with the specified error message and nested exception.
	WebException(String^, Exception^, WebExceptionStatus, WebResponse^)	Initializes a new instance of the WebException class with the specified error message, nested exception, status, and response.
	WebException(String^, WebExceptionStatus)	Initializes a new instance of the WebException class with the specified error message and status.

Properties

	Name	Description
	Data	Gets a collection of key/value pairs that provide additional user-defined information about the exception.(Inherited from Exception.)
	HelpLink	Gets or sets a link to the help file associated with this exception.(Inherited from Exception.)
	HResult	Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.(Inherited from Exception.)
	InnerException	Gets the Exception instance that caused the current exception.(Inherited from Exception.)
	Message	Gets a message that describes the current exception.(Inherited from Exception.)
	Response	Gets the response that the remote host returned.
	Source	Gets or sets the name of the application or the object that causes the error.(Inherited from Exception.)
	StackTrace	Gets a string representation of the immediate frames on the call stack.(Inherited from Exception.)
	Status	Gets the status of the response.
	TargetSite	Gets the method that throws the current exception.(Inherited from Exception.)

Methods

	Name	Description
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetBaseException()	When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.(Inherited from Exception.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetObjectData(SerializationInfo^, StreamingContext)	This API supports the product infrastructure and is not intended to be used directly from your code. Populates a SerializationInfo instance with the data needed to serialize the WebException.(Overrides Exception::GetObjectData(SerializationInfo^, StreamingContext).)
	GetType()	Gets the runtime type of the current instance.(Inherited from Exception.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	ToString()	Creates and returns a string representation of the current exception.(Inherited from Exception.)

Events

	Name	Description
	SerializeObjectState	Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.(Inherited from Exception.)

Explicit Interface Implementations

	Name	Description
	ISerializable::GetObjectData(SerializationInfo^, StreamingContext)	This API supports the product infrastructure and is not intended to be used directly from your code. Serializes this instance into the specified SerializationInfo object.

Remarks

The WebException class is thrown by classes descended from WebRequest and WebResponse that implement pluggable protocols for accessing the Internet.

When WebException is thrown by a descendant of the WebRequest class, the Response property provides the Internet response to the application.

Associated Tips

Check the Response property of the exception to determine why the request failed.: When a WebException exception is thrown by a descendent of the WebRequest class, the Response property provides the Internet response to the application.
Check the Status property of the exception to determine why the request failed.: The Status property of the exception provides status information for the error. For more information, see WebExceptionStatus.
If you are timing out when stepping into an XML Web Service, set the timeout value for the XML Web Service call to infinite.: For more information, see Error: Timeout While Debugging Web Services.

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.