kernel32/CloseHandle.ps1
|
function CloseHandle { <# .SYNOPSIS Closes an open object handle. .DESCRIPTION The CloseHandle function closes handles to the following objects: - Access token - Communications device - Console input - Console screen buffer - Event - File - File mapping - I/O completion port - Job - Mailslot - Memory resource notification - Mutex - Named pipe - Pipe - Process - Semaphore - Thread - Transaction - Waitable timer The documentation for the functions that create these objects indicates that CloseHandle should be used when you are finished with the object, and what happens to pending operations on the object after the handle is closed. In general, CloseHandle invalidates the specified object handle, decrements the object's handle count, and performs object retention checks. After the last handle to an object is closed, the object is removed from the system. .PARAMETER Handle A valid handle to an open object. .NOTES Author: Jared Atkinson (@jaredcatkinson) License: BSD 3-Clause Required Dependencies: PSReflect Optional Dependencies: None (func kernel32 CloseHandle ([bool]) @( [IntPtr] #_In_ HANDLE hObject ) -EntryPoint CloseHandle -SetLastError) .LINK https://msdn.microsoft.com/en-us/library/windows/desktop/ms724211(v=vs.85).aspx .EXAMPLE #> param ( [Parameter(Mandatory = $true)] [IntPtr] $Handle ) $SUCCESS = $Kernel32::CloseHandle($Handle); $LastError = [Runtime.InteropServices.Marshal]::GetLastWin32Error() if(-not $SUCCESS) { Write-Debug "CloseHandle Error: $(([ComponentModel.Win32Exception] $LastError).Message)" } } |