You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

53 rivejä
3.1 KiB

  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. using System;
  22. using System.Diagnostics.CodeAnalysis;
  23. using System.Runtime.InteropServices;
  24. using System.Security;
  25. namespace Alphaleonis.Win32.Filesystem
  26. {
  27. internal static partial class NativeMethods
  28. {
  29. /// <summary>Closes an open object handle.</summary>
  30. /// <remarks>
  31. /// <para>The CloseHandle function closes handles to the following objects:</para>
  32. /// <para>Access token, Communications device, Console input, Console screen buffer, Event, File, File mapping, I/O completion port,
  33. /// Job, Mailslot, Memory resource notification, Mutex, Named pipe, Pipe, Process, Semaphore, Thread, Transaction, Waitable
  34. /// timer.</para>
  35. /// <para>SetLastError is set to <see langword="false"/>.</para>
  36. /// <para>Minimum supported client: Windows 2000 Professional [desktop apps | Windows Store apps]</para>
  37. /// <para>Minimum supported server: Windows 2000 Server [desktop apps | Windows Store apps]</para>
  38. /// </remarks>
  39. /// <returns>
  40. /// <para>If the function succeeds, the return value is nonzero.</para>
  41. /// <para>If the function fails, the return value is zero. To get extended error information, call GetLastError.</para>
  42. /// <para>If the application is running under a debugger, the function will throw an exception if it receives either a handle value
  43. /// that is not valid or a pseudo-handle value.This can happen if you close a handle twice, or if you call CloseHandle on a handle
  44. /// returned by the FindFirstFile function instead of calling the FindClose function.</para>
  45. /// </returns>
  46. [SuppressMessage("Microsoft.Security", "CA5122:PInvokesShouldNotBeSafeCriticalFxCopRule")]
  47. [DllImport("kernel32.dll", SetLastError = false, CharSet = CharSet.Unicode), SuppressUnmanagedCodeSecurity]
  48. [return: MarshalAs(UnmanagedType.Bool)]
  49. internal static extern bool CloseHandle(IntPtr hObject);
  50. }
  51. }