WebException Class

Reference

Definition

Namespace:: System.Net

Assembly:: System.Net.Requests.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: WebException.cs

Source:: WebException.cs

Source:: WebException.cs

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.

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

public ref class WebException : InvalidOperationException

public class WebException : InvalidOperationException

[System.Serializable]
public class WebException : InvalidOperationException

type WebException = class
    inherit InvalidOperationException

type WebException = class
    inherit InvalidOperationException
    interface ISerializable

[<System.Serializable>]
type WebException = class
    inherit InvalidOperationException
    interface ISerializable

Public Class WebException
Inherits InvalidOperationException

Inheritance: Object

Exception

InvalidOperationException
WebException

Inheritance: Object

Exception

SystemException

InvalidOperationException
WebException

Attributes: SerializableAttribute

Implements: ISerializable

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.

Constructors

WebException()	Initializes a new instance of the WebException class.
WebException(SerializationInfo, StreamingContext)	Obsolete. 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

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

Equals(Object)	Determines whether the specified object is equal to the current object. (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)	Obsolete. Populates a SerializationInfo instance with the data needed to serialize the WebException.
GetObjectData(SerializationInfo, StreamingContext)	Obsolete. When overridden in a derived class, sets the SerializationInfo with information about the exception. (Inherited from Exception)
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

SerializeObjectState

Obsolete.

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

ISerializable.GetObjectData(SerializationInfo, StreamingContext)

Serializes this instance into the specified SerializationInfo object.

Applies to

Jaa