Win32 API 日本語リファレンス
ホームFoundation › SetHandleInformation

SetHandleInformation

関数
オブジェクトハンドルのプロパティフラグを設定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SetHandleInformation(
    HANDLE hObject,
    DWORD dwMask,
    HANDLE_FLAGS dwFlags
);

パラメーター

名前方向説明
hObjectHANDLEin

情報を設定するオブジェクトへのハンドル。

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

dwMaskDWORDin変更するビットフラグを指定するマスク。dwFlags の説明に示されているものと同じ定数を使用します。
dwFlagsHANDLE_FLAGSin

オブジェクトハンドルのプロパティを指定するビットフラグのセット。このパラメーターには 0、または次の値のうち 1 つ以上を指定できます。

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

関数が成功すると、戻り値は 0 以外の値になります。

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

解説(Remarks)

dwFlags 内の関連するビットフラグを設定またはクリアするには、dwMask に変更マスクのビットフラグを設定する必要があります。

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

各言語での呼び出し定義

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

BOOL SetHandleInformation(
    HANDLE hObject,
    DWORD dwMask,
    HANDLE_FLAGS dwFlags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetHandleInformation(
    IntPtr hObject,   // HANDLE
    uint dwMask,   // DWORD
    uint dwFlags   // HANDLE_FLAGS
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetHandleInformation(
    hObject As IntPtr,   ' HANDLE
    dwMask As UInteger,   ' DWORD
    dwFlags As UInteger   ' HANDLE_FLAGS
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hObject : HANDLE
' dwMask : DWORD
' dwFlags : HANDLE_FLAGS
Declare PtrSafe Function SetHandleInformation Lib "kernel32" ( _
    ByVal hObject As LongPtr, _
    ByVal dwMask As Long, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetHandleInformation = ctypes.windll.kernel32.SetHandleInformation
SetHandleInformation.restype = wintypes.BOOL
SetHandleInformation.argtypes = [
    wintypes.HANDLE,  # hObject : HANDLE
    wintypes.DWORD,  # dwMask : DWORD
    wintypes.DWORD,  # dwFlags : HANDLE_FLAGS
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetHandleInformation = Fiddle::Function.new(
  lib['SetHandleInformation'],
  [
    Fiddle::TYPE_VOIDP,  # hObject : HANDLE
    -Fiddle::TYPE_INT,  # dwMask : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : HANDLE_FLAGS
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetHandleInformation(
        hObject: *mut core::ffi::c_void,  // HANDLE
        dwMask: u32,  // DWORD
        dwFlags: u32  // HANDLE_FLAGS
    ) -> 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 SetHandleInformation(IntPtr hObject, uint dwMask, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetHandleInformation' -Namespace Win32 -PassThru
# $api::SetHandleInformation(hObject, dwMask, dwFlags)
#uselib "KERNEL32.dll"
#func global SetHandleInformation "SetHandleInformation" sptr, sptr, sptr
; SetHandleInformation hObject, dwMask, dwFlags   ; 戻り値は stat
; hObject : HANDLE -> "sptr"
; dwMask : DWORD -> "sptr"
; dwFlags : HANDLE_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetHandleInformation "SetHandleInformation" sptr, int, int
; res = SetHandleInformation(hObject, dwMask, dwFlags)
; hObject : HANDLE -> "sptr"
; dwMask : DWORD -> "int"
; dwFlags : HANDLE_FLAGS -> "int"
; BOOL SetHandleInformation(HANDLE hObject, DWORD dwMask, HANDLE_FLAGS dwFlags)
#uselib "KERNEL32.dll"
#cfunc global SetHandleInformation "SetHandleInformation" intptr, int, int
; res = SetHandleInformation(hObject, dwMask, dwFlags)
; hObject : HANDLE -> "intptr"
; dwMask : DWORD -> "int"
; dwFlags : HANDLE_FLAGS -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetHandleInformation = kernel32.NewProc("SetHandleInformation")
)

// hObject (HANDLE), dwMask (DWORD), dwFlags (HANDLE_FLAGS)
r1, _, err := procSetHandleInformation.Call(
	uintptr(hObject),
	uintptr(dwMask),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetHandleInformation(
  hObject: THandle;   // HANDLE
  dwMask: DWORD;   // DWORD
  dwFlags: DWORD   // HANDLE_FLAGS
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetHandleInformation';
result := DllCall("KERNEL32\SetHandleInformation"
    , "Ptr", hObject   ; HANDLE
    , "UInt", dwMask   ; DWORD
    , "UInt", dwFlags   ; HANDLE_FLAGS
    , "Int")   ; return: BOOL
●SetHandleInformation(hObject, dwMask, dwFlags) = DLL("KERNEL32.dll", "bool SetHandleInformation(void*, dword, dword)")
# 呼び出し: SetHandleInformation(hObject, dwMask, dwFlags)
# hObject : HANDLE -> "void*"
# dwMask : DWORD -> "dword"
# dwFlags : HANDLE_FLAGS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn SetHandleInformation(
    hObject: ?*anyopaque, // HANDLE
    dwMask: u32, // DWORD
    dwFlags: u32 // HANDLE_FLAGS
) callconv(std.os.windows.WINAPI) i32;
proc SetHandleInformation(
    hObject: pointer,  # HANDLE
    dwMask: uint32,  # DWORD
    dwFlags: uint32  # HANDLE_FLAGS
): int32 {.importc: "SetHandleInformation", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int SetHandleInformation(
    void* hObject,   // HANDLE
    uint dwMask,   // DWORD
    uint dwFlags   // HANDLE_FLAGS
);
ccall((:SetHandleInformation, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, UInt32),
      hObject, dwMask, dwFlags)
# hObject : HANDLE -> Ptr{Cvoid}
# dwMask : DWORD -> UInt32
# dwFlags : HANDLE_FLAGS -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetHandleInformation(
    void* hObject,
    uint32_t dwMask,
    uint32_t dwFlags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetHandleInformation(hObject, dwMask, dwFlags)
-- hObject : HANDLE
-- dwMask : DWORD
-- dwFlags : HANDLE_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetHandleInformation = lib.func('__stdcall', 'SetHandleInformation', 'int32_t', ['void *', 'uint32_t', 'uint32_t']);
// SetHandleInformation(hObject, dwMask, dwFlags)
// hObject : HANDLE -> 'void *'
// dwMask : DWORD -> 'uint32_t'
// dwFlags : HANDLE_FLAGS -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetHandleInformation: { parameters: ["pointer", "u32", "u32"], result: "i32" },
});
// lib.symbols.SetHandleInformation(hObject, dwMask, dwFlags)
// hObject : HANDLE -> "pointer"
// dwMask : DWORD -> "u32"
// dwFlags : HANDLE_FLAGS -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetHandleInformation(
    void* hObject,
    uint32_t dwMask,
    uint32_t dwFlags);
C, "KERNEL32.dll");
// $ffi->SetHandleInformation(hObject, dwMask, dwFlags);
// hObject : HANDLE
// dwMask : DWORD
// dwFlags : HANDLE_FLAGS
// 構造体/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 SetHandleInformation(
        Pointer hObject,   // HANDLE
        int dwMask,   // DWORD
        int dwFlags   // HANDLE_FLAGS
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun SetHandleInformation = SetHandleInformation(
    hObject : Void*,   # HANDLE
    dwMask : UInt32,   # DWORD
    dwFlags : UInt32   # HANDLE_FLAGS
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetHandleInformationNative = Int32 Function(Pointer<Void>, Uint32, Uint32);
typedef SetHandleInformationDart = int Function(Pointer<Void>, int, int);
final SetHandleInformation = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetHandleInformationNative, SetHandleInformationDart>('SetHandleInformation');
// hObject : HANDLE -> Pointer<Void>
// dwMask : DWORD -> Uint32
// dwFlags : HANDLE_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetHandleInformation(
  hObject: THandle;   // HANDLE
  dwMask: DWORD;   // DWORD
  dwFlags: DWORD   // HANDLE_FLAGS
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetHandleInformation';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetHandleInformation"
  c_SetHandleInformation :: Ptr () -> Word32 -> Word32 -> IO CInt
-- hObject : HANDLE -> Ptr ()
-- dwMask : DWORD -> Word32
-- dwFlags : HANDLE_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let sethandleinformation =
  foreign "SetHandleInformation"
    ((ptr void) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* hObject : HANDLE -> (ptr void) *)
(* dwMask : DWORD -> uint32_t *)
(* dwFlags : HANDLE_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("SetHandleInformation" set-handle-information :convention :stdcall) :int32
  (h-object :pointer)   ; HANDLE
  (dw-mask :uint32)   ; DWORD
  (dw-flags :uint32))   ; HANDLE_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetHandleInformation = Win32::API::More->new('KERNEL32',
    'BOOL SetHandleInformation(HANDLE hObject, DWORD dwMask, DWORD dwFlags)');
# my $ret = $SetHandleInformation->Call($hObject, $dwMask, $dwFlags);
# hObject : HANDLE -> HANDLE
# dwMask : DWORD -> DWORD
# dwFlags : HANDLE_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型