ホーム › Foundation › GetHandleInformation

GetHandleInformation

関数

オブジェクトハンドルのプロパティフラグを取得する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL GetHandleInformation(
    HANDLE hObject,
    DWORD* lpdwFlags
);

パラメーター

名前

型

方向

説明

hObject

HANDLE

情報を取得する対象のオブジェクトへのハンドル。

次のいずれかの種類のオブジェクトへのハンドルを指定できます: アクセストークン、コンソール入力バッファー、コンソールスクリーンバッファー、イベント、ファイル、ファイルマッピング、ジョブ、メールスロット、ミューテックス、パイプ、プリンター、プロセス、レジストリキー、セマフォ、シリアル通信デバイス、ソケット、スレッド、または待機可能タイマー。

lpdwFlags

DWORD*

out

オブジェクトハンドルのプロパティを指定する一連のビットフラグ、または 0 を受け取る変数へのポインター。次の値が定義されています。

値	意味
HANDLE_FLAG_INHERIT 0x00000001	このフラグが設定されている場合、bInheritHandles パラメーターを TRUE に設定して CreateProcess で作成された子プロセスは、このオブジェクトハンドルを継承します。
HANDLE_FLAG_PROTECT_FROM_CLOSE 0x00000002	このフラグが設定されている場合、 CloseHandle 関数を呼び出してもオブジェクトハンドルは閉じられません。

戻り値の型: BOOL

公式ドキュメント

オブジェクトハンドルの特定のプロパティを取得します。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL GetHandleInformation(
    HANDLE hObject,
    DWORD* lpdwFlags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetHandleInformation(
    IntPtr hObject,   // HANDLE
    out uint lpdwFlags   // DWORD* out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetHandleInformation(
    hObject As IntPtr,   ' HANDLE
    <Out> ByRef lpdwFlags As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hObject : HANDLE
' lpdwFlags : DWORD* out
Declare PtrSafe Function GetHandleInformation Lib "kernel32" ( _
    ByVal hObject As LongPtr, _
    ByRef lpdwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetHandleInformation = ctypes.windll.kernel32.GetHandleInformation
GetHandleInformation.restype = wintypes.BOOL
GetHandleInformation.argtypes = [
    wintypes.HANDLE,  # hObject : HANDLE
    ctypes.POINTER(wintypes.DWORD),  # lpdwFlags : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetHandleInformation = Fiddle::Function.new(
  lib['GetHandleInformation'],
  [
    Fiddle::TYPE_VOIDP,  # hObject : HANDLE
    Fiddle::TYPE_VOIDP,  # lpdwFlags : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetHandleInformation(
        hObject: *mut core::ffi::c_void,  // HANDLE
        lpdwFlags: *mut u32  // DWORD* out
    ) -> 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 GetHandleInformation(IntPtr hObject, out uint lpdwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetHandleInformation' -Namespace Win32 -PassThru
# $api::GetHandleInformation(hObject, lpdwFlags)

#uselib "KERNEL32.dll"
#func global GetHandleInformation "GetHandleInformation" sptr, sptr
; GetHandleInformation hObject, varptr(lpdwFlags)   ; 戻り値は stat
; hObject : HANDLE -> "sptr"
; lpdwFlags : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetHandleInformation "GetHandleInformation" sptr, var
; res = GetHandleInformation(hObject, lpdwFlags)
; hObject : HANDLE -> "sptr"
; lpdwFlags : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetHandleInformation "GetHandleInformation" sptr, sptr
; res = GetHandleInformation(hObject, varptr(lpdwFlags))
; hObject : HANDLE -> "sptr"
; lpdwFlags : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。