Nevar pievienot vairāk kā 25 tēmas Tēmai ir jāsākas ar burtu vai ciparu, tā var saturēt domu zīmes ('-') un var būt līdz 35 simboliem gara.

PathFormat.cs 3.5 KiB

pirms 7 gadiem
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. /* Copyright (C) 2008-2016 Peter Palotas, Jeffrey Jangli, Alexandr Normuradov
  2. *
  3. * Permission is hereby granted, free of charge, to any person obtaining a copy
  4. * of this software and associated documentation files (the "Software"), to deal
  5. * in the Software without restriction, including without limitation the rights
  6. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  7. * copies of the Software, and to permit persons to whom the Software is
  8. * furnished to do so, subject to the following conditions:
  9. *
  10. * The above copyright notice and this permission notice shall be included in
  11. * all copies or substantial portions of the Software.
  12. *
  13. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  18. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  19. * THE SOFTWARE.
  20. */
  21. namespace Alphaleonis.Win32.Filesystem
  22. {
  23. /// <summary>Indicates the format of a path passed to a method.</summary>
  24. /// <remarks>
  25. /// At some point in code you know the full path of file system objects, e.g.: "C:\Windows".
  26. /// For example, Directory.EnumerateFileSystemEntries() will return all files and directories from a given path.
  27. /// Most likely, some processing will happen on the results of the enum. The file or directory may be passed
  28. /// on to another function. Whenever a file path is required, some performance can be gained.
  29. /// <para>&#160;</para>
  30. /// A path like: "C:\Windows" or "\\server\share" is considered a full path for a directory because it is rooted and has a drive/unc path.
  31. /// If the method supports it, <see cref="PathFormat.FullPath"/> and <see cref="PathFormat.LongFullPath"/> will skip GetFullPath()
  32. /// calls for path resolving of the object, while also avoiding path validation and checks.
  33. /// Using <see cref="PathFormat.RelativePath"/> (default) will always call GetFullPath() and perform path validation and checks.
  34. /// <para>&#160;</para>
  35. /// When working in a loop with thousands of files, <see cref="PathFormat.LongFullPath"/> will give the best performance.
  36. /// </remarks>
  37. public enum PathFormat
  38. {
  39. /// <summary>The format of the path is automatically detected by the method and internally converted to an extended length path.
  40. /// It can be either a standard (short) full path, an extended length (unicode) full path or a relative path.
  41. /// <para>Example relative path: "Windows".</para>
  42. /// </summary>
  43. RelativePath,
  44. /// <summary>The path is a full path in either normal or extended length (UNICODE) format.
  45. /// Internally it will be converted to an extended length (UNICODE) path.
  46. /// Using this option has a very slight performance advantage compared to using <see cref="RelativePath"/>.
  47. /// <para>Example full path: "C:\Windows" or "\\server\share".</para>
  48. /// </summary>
  49. FullPath,
  50. /// <summary>The path is an extended length path. No additional processing will be done on the path, and it will be used as is.
  51. /// Using this option has a slight performance advantage compared to using <see cref="RelativePath"/>.
  52. /// <para>Example long full path: "\\?\C:\Windows" or "\\?\UNC\server\share".</para>
  53. /// </summary>
  54. LongFullPath
  55. }
  56. }