PathTooLongException PathTooLongException PathTooLongException PathTooLongException Class

Definition

The exception that is thrown when a path or fully qualified file name is longer than the system-defined maximum length.

public ref class PathTooLongException : System::IO::IOException
[System.Runtime.InteropServices.ComVisible(true)]
[Serializable]
public class PathTooLongException : System.IO.IOException
type PathTooLongException = class
    inherit IOException
Public Class PathTooLongException
Inherits IOException
Inheritance
Attributes
ComVisibleAttribute SerializableAttribute

Remarks

If your code does not have FileIOPermissionAttribute.PathDiscovery permission, the error message for this exception may contain only file or directory names instead of full paths.

In apps that run under versions of the .NET Framework prior to the .NET Framework 4.6.2, full paths must not exceed 260 characters to maintain compatibility with Windows operating systems. Any path in excess of 260 characters automatically throws a PathTooLongException. For more information about this restriction, see the entry Long Paths in .NET in the BCL Team blog.

Note

This exception is not included in .NET for Windows Store apps or the Portable Class Library, but it is thrown by some members that are. To catch the exception in that case, write a catch statement that handles an IOException instead.

Starting with apps running under the .NET Framework 4.6.2, the .NET Framework supports long paths in excess of 260 (or MAX_PATH) characters. The conditions under which a PathTooLongException exception are thrown depend on the version of the .NET Framework that an app targets:

Apps that target the .NET Framework 4.6.2 and later versions
Long paths are supported by default. The runtime throws a PathTooLongException under the following conditions:

  • The operating system returns COR_E_PATHTOOLONG or its equivalent.

  • The length of the path exceeds Int16.MaxValue (32,767) characters.

Apps that target the .NET Framework 4.6.1 and earlier versions
Long paths are disabled by default, and the legacy behavior is maintained. The runtime throws a PathTooLongException whenever a path exceeds 260 characters.

If this is undesirable, apps that target the .NET Framework 4.6.1 and earlier but run under the .NET Framework 4.6.2 can enable long path support by including the following setting in the <runtime> element of the application configuration file:


<runtime>   
   <AppContextSwitchOverrides value="Switch.System.IO.UseLegacyPathHandling=false" />   
</runtime>  

PathTooLongException uses the HRESULT COR_E_PATHTOOLONG, which has the value 0x800700CE.

Constructors

PathTooLongException() PathTooLongException() PathTooLongException() PathTooLongException()

Initializes a new instance of the PathTooLongException class with its HRESULT set to COR_E_PATHTOOLONG.

PathTooLongException(SerializationInfo, StreamingContext) PathTooLongException(SerializationInfo, StreamingContext) PathTooLongException(SerializationInfo, StreamingContext) PathTooLongException(SerializationInfo, StreamingContext)

Initializes a new instance of the PathTooLongException class with the specified serialization and context information.

PathTooLongException(String) PathTooLongException(String) PathTooLongException(String) PathTooLongException(String)

Initializes a new instance of the PathTooLongException class with its message string set to message and its HRESULT set to COR_E_PATHTOOLONG.

PathTooLongException(String, Exception) PathTooLongException(String, Exception) PathTooLongException(String, Exception) PathTooLongException(String, Exception)

Initializes a new instance of the PathTooLongException class with a specified error message and a reference to the inner exception that is the cause of this exception.

Properties

Data Data Data Data

Gets a collection of key/value pairs that provide additional user-defined information about the exception.

(Inherited from Exception)
HelpLink HelpLink HelpLink HelpLink

Gets or sets a link to the help file associated with this exception.

(Inherited from Exception)
HResult HResult HResult HResult

Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.

(Inherited from Exception)
InnerException InnerException InnerException InnerException

Gets the Exception instance that caused the current exception.

(Inherited from Exception)
Message Message Message Message

Gets a message that describes the current exception.

(Inherited from Exception)
Source Source Source Source

Gets or sets the name of the application or the object that causes the error.

(Inherited from Exception)
StackTrace StackTrace StackTrace StackTrace

Gets a string representation of the immediate frames on the call stack.

(Inherited from Exception)
TargetSite TargetSite TargetSite TargetSite

Gets the method that throws the current exception.

(Inherited from Exception)

Methods

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetBaseException() GetBaseException() GetBaseException() 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() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext)

When overridden in a derived class, sets the SerializationInfo with information about the exception.

(Inherited from Exception)
GetType() GetType() GetType() GetType()

Gets the runtime type of the current instance.

(Inherited from Exception)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Creates and returns a string representation of the current exception.

(Inherited from Exception)

Events

SerializeObjectState SerializeObjectState SerializeObjectState SerializeObjectState

Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.

(Inherited from Exception)

Applies to

See Also