CloseHandle
関数シグネチャ
// KERNEL32.dll
#include <windows.h>
BOOL CloseHandle(
HANDLE hObject
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hObject | HANDLE | in | 開いているオブジェクトへの有効なハンドル。 |
戻り値の型: BOOL
公式ドキュメント
開いているオブジェクトハンドルを閉じます。
戻り値
関数が成功すると、戻り値は0以外になります。
関数が失敗すると、戻り値は0になります。拡張エラー情報を取得するには、 GetLastError を呼び出してください。
アプリケーションがデバッガーの下で実行されている場合、無効なハンドル値または疑似ハンドル値を受け取ると、関数は例外をスローします。これは、ハンドルを2回閉じた場合や、FindClose 関数を呼び出すべきところで FindFirstFile 関数が返したハンドルに対して CloseHandle を呼び出した場合に発生する可能性があります。
解説(Remarks)
CloseHandle 関数は、次のオブジェクトへのハンドルを閉じます。
- アクセストークン
- 通信デバイス
- コンソール入力
- コンソール画面バッファー
- イベント
- ファイル
- ファイルマッピング
- I/O完了ポート
- ジョブ
- メールスロット
- メモリリソース通知
- ミューテックス
- 名前付きパイプ
- パイプ
- プロセス
- セマフォ
- スレッド
- トランザクション
- 待機可能タイマー
一般に、アプリケーションは開いた各ハンドルに対して CloseHandle を1回呼び出す必要があります。ハンドルを使用する関数が ERROR_INVALID_HANDLE で失敗した場合、通常このエラーはハンドルがすでに無効化されていることを示すため、CloseHandle を呼び出す必要は通常ありません。ただし、一部の関数は ERROR_INVALID_HANDLE を使用してオブジェクト自体がもはや有効でないことを示します。たとえば、ネットワーク上のファイルへのハンドルを使用しようとする関数は、ネットワーク接続が切断されるとファイルオブジェクトがもはや利用できなくなるため、ERROR_INVALID_HANDLE で失敗することがあります。この場合、アプリケーションはハンドルを閉じる必要があります。
ハンドルがトランザクション処理されている場合、トランザクションをコミットする前に、トランザクションにバインドされたすべてのハンドルを閉じる必要があります。トランザクション処理されたハンドルが FILE_FLAG_DELETE_ON_CLOSE フラグを指定して CreateFileTransacted を呼び出して開かれた場合、アプリケーションがハンドルを閉じて CommitTransaction を呼び出すまで、ファイルは削除されません。トランザクション処理されたオブジェクトの詳細については、Working With Transactions を参照してください。
スレッドハンドルを閉じても、関連するスレッドは終了せず、スレッドオブジェクトも削除されません。プロセスハンドルを閉じても、関連するプロセスは終了せず、プロセスオブジェクトも削除されません。スレッドオブジェクトを削除するには、スレッドを終了し、そのスレッドへのすべてのハンドルを閉じる必要があります。詳細については、Terminating a Thread を参照してください。プロセスオブジェクトを削除するには、プロセスを終了し、そのプロセスへのすべてのハンドルを閉じる必要があります。詳細については、Terminating a Process を参照してください。
ファイルマッピングへのハンドルを閉じる操作は、まだ開いているファイルビューが存在する場合でも成功することがあります。詳細については、Closing a File Mapping Object を参照してください。
ソケットを閉じるために CloseHandle 関数を使用しないでください。代わりに、ソケットオブジェクトへのハンドルを含む、ソケットに関連付けられたすべてのリソースを解放する closesocket 関数を使用してください。詳細については、Socket Closure を参照してください。
開いているレジストリキーへのハンドルを閉じるために CloseHandle 関数を使用しないでください。代わりに、RegCloseKey 関数を使用してください。CloseHandle はレジストリキーへのハンドルを閉じませんが、この失敗を示すエラーも返しません。
例
dwPriorityClass = 0;
hProcess = OpenProcess( PROCESS_ALL_ACCESS, FALSE, pe32.th32ProcessID );
if( hProcess == NULL )
printError( TEXT("OpenProcess") );
else
{
dwPriorityClass = GetPriorityClass( hProcess );
if( !dwPriorityClass )
printError( TEXT("GetPriorityClass") );
CloseHandle( hProcess );
}
この例を文脈の中で確認するには、 Taking a Snapshot and Viewing Processes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
BOOL CloseHandle(
HANDLE hObject
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CloseHandle(
IntPtr hObject // HANDLE
);<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CloseHandle(
hObject As IntPtr ' HANDLE
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hObject : HANDLE
Declare PtrSafe Function CloseHandle Lib "kernel32" ( _
ByVal hObject As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
CloseHandle = ctypes.windll.kernel32.CloseHandle
CloseHandle.restype = wintypes.BOOL
CloseHandle.argtypes = [
wintypes.HANDLE, # hObject : HANDLE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
CloseHandle = Fiddle::Function.new(
lib['CloseHandle'],
[
Fiddle::TYPE_VOIDP, # hObject : HANDLE
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn CloseHandle(
hObject: *mut core::ffi::c_void // HANDLE
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool CloseHandle(IntPtr hObject);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CloseHandle' -Namespace Win32 -PassThru
# $api::CloseHandle(hObject)#uselib "KERNEL32.dll"
#func global CloseHandle "CloseHandle" sptr
; CloseHandle hObject ; 戻り値は stat
; hObject : HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global CloseHandle "CloseHandle" sptr
; res = CloseHandle(hObject)
; hObject : HANDLE -> "sptr"; BOOL CloseHandle(HANDLE hObject)
#uselib "KERNEL32.dll"
#cfunc global CloseHandle "CloseHandle" intptr
; res = CloseHandle(hObject)
; hObject : HANDLE -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procCloseHandle = kernel32.NewProc("CloseHandle")
)
// hObject (HANDLE)
r1, _, err := procCloseHandle.Call(
uintptr(hObject),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction CloseHandle(
hObject: THandle // HANDLE
): BOOL; stdcall;
external 'KERNEL32.dll' name 'CloseHandle';result := DllCall("KERNEL32\CloseHandle"
, "Ptr", hObject ; HANDLE
, "Int") ; return: BOOL●CloseHandle(hObject) = DLL("KERNEL32.dll", "bool CloseHandle(void*)")
# 呼び出し: CloseHandle(hObject)
# hObject : HANDLE -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn CloseHandle(
hObject: ?*anyopaque // HANDLE
) callconv(std.os.windows.WINAPI) i32;proc CloseHandle(
hObject: pointer # HANDLE
): int32 {.importc: "CloseHandle", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int CloseHandle(
void* hObject // HANDLE
);ccall((:CloseHandle, "KERNEL32.dll"), stdcall, Int32,
(Ptr{Cvoid},),
hObject)
# hObject : HANDLE -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t CloseHandle(
void* hObject);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.CloseHandle(hObject)
-- hObject : HANDLE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const CloseHandle = lib.func('__stdcall', 'CloseHandle', 'int32_t', ['void *']);
// CloseHandle(hObject)
// hObject : HANDLE -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
CloseHandle: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.CloseHandle(hObject)
// hObject : HANDLE -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t CloseHandle(
void* hObject);
C, "KERNEL32.dll");
// $ffi->CloseHandle(hObject);
// hObject : HANDLE
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Kernel32 extends StdCallLibrary {
Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
boolean CloseHandle(
Pointer hObject // HANDLE
);
}@[Link("kernel32")]
lib LibKERNEL32
fun CloseHandle = CloseHandle(
hObject : Void* # HANDLE
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef CloseHandleNative = Int32 Function(Pointer<Void>);
typedef CloseHandleDart = int Function(Pointer<Void>);
final CloseHandle = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<CloseHandleNative, CloseHandleDart>('CloseHandle');
// hObject : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function CloseHandle(
hObject: THandle // HANDLE
): BOOL; stdcall;
external 'KERNEL32.dll' name 'CloseHandle';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "CloseHandle"
c_CloseHandle :: Ptr () -> IO CInt
-- hObject : HANDLE -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let closehandle =
foreign "CloseHandle"
((ptr void) @-> returning int32_t)
(* hObject : HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("CloseHandle" close-handle :convention :stdcall) :int32
(h-object :pointer)) ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $CloseHandle = Win32::API::More->new('KERNEL32',
'BOOL CloseHandle(HANDLE hObject)');
# my $ret = $CloseHandle->Call($hObject);
# hObject : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f CreateFileW — ファイルやデバイスを作成または開いてハンドルを返す。
- f CreateFileTransactedW — トランザクション内でファイルを作成・オープンする(Unicode版)。
- f DeleteFileW — 指定したファイルを削除する。
- f FindClose — ファイル検索ハンドルを閉じて検索を終了する。
- f FindFirstFileW — 条件に一致する最初のファイルを検索する。