Long Paths in .NET, Part 1 of 3 [Kim Hamilton]

Long Paths in .NET, Part 1 of 3 [Kim Hamilton]

Rate This
  • Comments 30

Let’s start by looking at one of the more interesting exception messages in the BCL, the PathTooLongException:

[PathTooLongException]: The specified path, file name, or both are too long. The fully qualified file name must be less than 260 characters, and the directory name must be less than 248 characters.

"260 characters? That’s ridiculous; increase the limit", say our customer bug reports. To everyone who got their bug resolved as "won’t fix", we’d like to explain this problem more completely and describe current efforts to address it.

To avoid confusion, let’s get some terminology out of the way:

  • Path: a fully-qualified file name or directory name. In other words, if you have a file C:\temp\fileA.txt, the file name is often called fileA.txt, but the path or fully-qualified file name is C:\temp\fileA.txt
  • MAX_PATH: This is the maximum length of a path according to the Windows API, defined as 260 characters.
  • Long path: a path that can be longer than MAX_PATH characters.
  • Long file name: not the same as a long path. This term is used in contrast to short file names – those 8.3 names you may remember using long ago.

.NET APIs depend heavily on the Windows APIs, so based on these definitions, it may sound like long paths are immediately out of the question. However, the Windows file APIs provide a way to get around this limitation. If you prefix the file name with "\\?\" and call the Unicode versions of the Windows APIs, then you can use file names up to 32K characters in length. In other words, the \\?\ prefix is a way to enable long paths while working with the Windows file APIs.

Very few people complain about a 32K limit, so, problem solved? Not quite. There are several reasons we were reluctant to add long paths in the past, and why we’re still careful about it, related to security, inconsistent support in the Windows APIs of the \\?\ syntax, and app compatibility.

First about security, the \\?\ prefix not only enables long paths; it causes the path to be passed to the file system with minimal modification by the Windows APIs. A consequence is that \\?\ turns off file name normalization performed by Windows APIs, including removing trailing spaces, expanding ‘.’ and ‘..’, converting relative paths into full paths, and so on. The existence of FileIOPermissions in .NET means that we absolutely have to work with normalized paths, or risk exposing a security threat. So we knew that if we wanted to use the \\?\ prefix as part of the long path solution, we’d need the ability to normalize these paths as expected.

Another concern is inconsistent behavior that would result by exposing long path support. Long paths with the \\?\ prefix can be used in most of the file-related Windows APIs, but not all Windows APIs. For example, LoadLibrary, which maps a module into the address of the calling process, fails if the file name is longer than MAX_PATH. So this means MoveFile will let you move a DLL to a location such that its path is longer than 260 characters, but when you try to load the DLL, it would fail. There are similar examples throughout the Windows APIs; some workarounds exist, but they are on a case-by-case basis.

Another factor, which is considered more of a pain factor, is compatibility with other Windows-based applications and the Windows shell itself, which only work with paths shorter than MAX_PATH (note that the Vista shell attempts to soften this limit, briefly described below). This means that if .NET supports long paths, then we’d let you create files that you couldn’t access via Explorer or the command prompt.

That said, we realize that enforcing the 260 character limit isn’t a reasonable long-term solution. Our customers don’t run into this problem very often, but when they do, they’re extremely inconvenienced. A possible workaround is P/Invoking to the Windows APIs and using the \\?\ prefix, but it would be a huge amount of code to duplicate the functionality in System.IO. So to work around the problem, customers often resort to an overhaul of directory organization, artificially shortening directory names (and updating every referencing location).

Because this problem is becoming increasingly common, also outside the .NET framework, there are efforts throughout Microsoft to address it. In fact, as a timely Vista plug, you’ll notice a couple of changes that reduce the chance of hitting the MAX_PATH limit: many of the special folder names have shortened and, more interestingly, the shell is using an auto-path shrinking feature, which involves using short name aliases for paths (behind the scenes) to attempt to squeeze them into 260 characters.

This is the first of a series of blogs on long paths. Our follow-ups will describe plans to support long paths in System.IO in a future version of the Common Language Runtime and some workarounds you can use in the meantime.

Related Links:

MSDN documentation on file naming rules, lengths, and the \\?\ prefix:
http://msdn2.microsoft.com/en-us/library/aa365247.aspx

Michael Kaplan’s blog describing file naming-related Vista shell changes:
http://blogs.msdn.com/michkap/archive/2006/12/13/1275292.aspx

Navigation

  • .NET Tips & Tricks Michael Nemtsev, Microsoft MVP Last update: June 13 , 2007 Document version 0

  • Common INFO: · const is "baked" into the assembly. If you have to change the const value in

  • This section describes the common .NET tips which don't relates to the specific category INFO: ·

  • This section describes the common .NET tips which don't relates to the specific category INFO: ·

  • While some of the build agent properties are available in the VS GUI, buried in the tfsbuildservice.exe.config

  • It appears that part 3 of the long path blog series on the BCL blog is now nearly a year overdue! This

  • It appears that part 3 of the long path blog series on the BCL blog is now nearly a year overdue! This

  • The source of the main title is an inside joke I am probably not going to ever explain within the blog.

  • This post applies to mostly to Team Build 2005 but users of later versions of TFS may find this useful

  • Updated 6/10/08 2:20pm: clarified details of proposed solution Here it is, Part 3 of the long path series

  • Finding Path lengths greater than MAX_PATH

  • Finding Path lengths greater than MAX_PATH

  • Finding Path lengths greater than MAX_PATH

  • Finding Path lengths greater than MAX_PATH

  • Finding Path lengths greater than MAX_PATH

Page 2 of 2 (30 items) 12