This documentation is archived and is not being maintained.
TimeoutException Class
Visual Studio 2010
The exception that is thrown when the time allotted for a process or operation has expired.
Assembly: mscorlib (in mscorlib.dll)
The TimeoutException type exposes the following members.
Name | Description | |
---|---|---|
TimeoutException() | Initializes a new instance of the TimeoutException class. | |
TimeoutException(String) | Initializes a new instance of the TimeoutException class with the specified error message. | |
TimeoutException(SerializationInfo, StreamingContext) | Initializes a new instance of the TimeoutException class with serialized data. | |
TimeoutException(String, Exception) | Initializes a new instance of the TimeoutException class with the specified error message and inner exception. |
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.) | |
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.) | |
TargetSite | Gets the method that throws the current exception. (Inherited from Exception.) |
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 a hash function for a particular type. (Inherited from Object.) | |
GetObjectData | 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.) In XNA Framework 3.0, this member is inherited from Object.GetType(). In Portable Class Library Portable Class Library, this member is inherited from Object.GetType(). | |
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.) |
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.) |
TimeoutException uses the HRESULT, COR_E_TIMEOUT, which has the value 0x80131505.
For a list of initial property values for an instance of TimeoutException, see the TimeoutException constructors.
The following code example demonstrates the use of TimeoutException in conjunction with members of the System.IO.Ports.SerialPort class.
// This example demonstrates the use of the TimeoutException // exception in conjunction with the SerialPort class. using System; using System.IO.Ports; class Sample { public static void Main() { string input; try { // Set the COM1 serial port to speed = 4800 baud, parity = odd, // data bits = 8, stop bits = 1. SerialPort sp = new SerialPort("COM1", 4800, Parity.Odd, 8, StopBits.One); // Timeout after 2 seconds. sp.ReadTimeout = 2000; sp.Open(); // Read until either the default newline termination string // is detected or the read operation times out. input = sp.ReadLine(); sp.Close(); // Echo the input. Console.WriteLine(input); } // Only catch timeout exceptions. catch (TimeoutException e) { Console.WriteLine(e); } } } /* This example produces the following results: (Data received at the serial port is echoed to the console if the read operation completes successfully before the specified timeout period expires. Otherwise, a timeout exception like the following is thrown.) System.TimeoutException: The operation has timed-out. at System.IO.Ports.SerialStream.ReadByte(Int32 timeout) at System.IO.Ports.SerialPort.ReadOneChar(Int32 timeout) at System.IO.Ports.SerialPort.ReadTo(String value) at System.IO.Ports.SerialPort.ReadLine() at Sample.Main() */
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: