Win32 API 日本語リファレンス
ホームSystem.Shutdown › ShutdownBlockReasonQuery

ShutdownBlockReasonQuery

関数
ウィンドウに登録されたシャットダウン阻止理由を取得する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL ShutdownBlockReasonQuery(
    HWND hWnd,
    LPWSTR pwszBuff,   // optional
    DWORD* pcchBuff
);

パラメーター

名前方向説明
hWndHWNDinブロック理由を問い合わせるウィンドウのハンドル。
pwszBuffLPWSTRoutoptionalブロック理由文字列を受け取るバッファ。NULLで必要長のみ取得する。
pcchBuffDWORD*inout入力時はバッファ文字数、出力時は実際の文字数を保持するポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL ShutdownBlockReasonQuery(
    HWND hWnd,
    LPWSTR pwszBuff,   // optional
    DWORD* pcchBuff
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ShutdownBlockReasonQuery(
    IntPtr hWnd,   // HWND
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pwszBuff,   // LPWSTR optional, out
    ref uint pcchBuff   // DWORD* in/out
);
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ShutdownBlockReasonQuery(
    hWnd As IntPtr,   ' HWND
    <MarshalAs(UnmanagedType.LPWStr)> pwszBuff As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef pcchBuff As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hWnd : HWND
' pwszBuff : LPWSTR optional, out
' pcchBuff : DWORD* in/out
Declare PtrSafe Function ShutdownBlockReasonQuery Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal pwszBuff As LongPtr, _
    ByRef pcchBuff As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ShutdownBlockReasonQuery = ctypes.windll.user32.ShutdownBlockReasonQuery
ShutdownBlockReasonQuery.restype = wintypes.BOOL
ShutdownBlockReasonQuery.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    wintypes.LPWSTR,  # pwszBuff : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchBuff : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
ShutdownBlockReasonQuery = Fiddle::Function.new(
  lib['ShutdownBlockReasonQuery'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_VOIDP,  # pwszBuff : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchBuff : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn ShutdownBlockReasonQuery(
        hWnd: *mut core::ffi::c_void,  // HWND
        pwszBuff: *mut u16,  // LPWSTR optional, out
        pcchBuff: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true)]
public static extern bool ShutdownBlockReasonQuery(IntPtr hWnd, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pwszBuff, ref uint pcchBuff);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_ShutdownBlockReasonQuery' -Namespace Win32 -PassThru
# $api::ShutdownBlockReasonQuery(hWnd, pwszBuff, pcchBuff)
#uselib "USER32.dll"
#func global ShutdownBlockReasonQuery "ShutdownBlockReasonQuery" sptr, sptr, sptr
; ShutdownBlockReasonQuery hWnd, varptr(pwszBuff), varptr(pcchBuff)   ; 戻り値は stat
; hWnd : HWND -> "sptr"
; pwszBuff : LPWSTR optional, out -> "sptr"
; pcchBuff : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USER32.dll"
#cfunc global ShutdownBlockReasonQuery "ShutdownBlockReasonQuery" sptr, var, var
; res = ShutdownBlockReasonQuery(hWnd, pwszBuff, pcchBuff)
; hWnd : HWND -> "sptr"
; pwszBuff : LPWSTR optional, out -> "var"
; pcchBuff : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL ShutdownBlockReasonQuery(HWND hWnd, LPWSTR pwszBuff, DWORD* pcchBuff)
#uselib "USER32.dll"
#cfunc global ShutdownBlockReasonQuery "ShutdownBlockReasonQuery" intptr, var, var
; res = ShutdownBlockReasonQuery(hWnd, pwszBuff, pcchBuff)
; hWnd : HWND -> "intptr"
; pwszBuff : LPWSTR optional, out -> "var"
; pcchBuff : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procShutdownBlockReasonQuery = user32.NewProc("ShutdownBlockReasonQuery")
)

// hWnd (HWND), pwszBuff (LPWSTR optional, out), pcchBuff (DWORD* in/out)
r1, _, err := procShutdownBlockReasonQuery.Call(
	uintptr(hWnd),
	uintptr(pwszBuff),
	uintptr(pcchBuff),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function ShutdownBlockReasonQuery(
  hWnd: THandle;   // HWND
  pwszBuff: PWideChar;   // LPWSTR optional, out
  pcchBuff: Pointer   // DWORD* in/out
): BOOL; stdcall;
  external 'USER32.dll' name 'ShutdownBlockReasonQuery';
result := DllCall("USER32\ShutdownBlockReasonQuery"
    , "Ptr", hWnd   ; HWND
    , "Ptr", pwszBuff   ; LPWSTR optional, out
    , "Ptr", pcchBuff   ; DWORD* in/out
    , "Int")   ; return: BOOL
●ShutdownBlockReasonQuery(hWnd, pwszBuff, pcchBuff) = DLL("USER32.dll", "bool ShutdownBlockReasonQuery(void*, char*, void*)")
# 呼び出し: ShutdownBlockReasonQuery(hWnd, pwszBuff, pcchBuff)
# hWnd : HWND -> "void*"
# pwszBuff : LPWSTR optional, out -> "char*"
# pcchBuff : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef ShutdownBlockReasonQueryNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Pointer<Uint32>);
typedef ShutdownBlockReasonQueryDart = int Function(Pointer<Void>, Pointer<Utf16>, Pointer<Uint32>);
final ShutdownBlockReasonQuery = DynamicLibrary.open('USER32.dll')
    .lookupFunction<ShutdownBlockReasonQueryNative, ShutdownBlockReasonQueryDart>('ShutdownBlockReasonQuery');
// hWnd : HWND -> Pointer<Void>
// pwszBuff : LPWSTR optional, out -> Pointer<Utf16>
// pcchBuff : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ShutdownBlockReasonQuery(
  hWnd: THandle;   // HWND
  pwszBuff: PWideChar;   // LPWSTR optional, out
  pcchBuff: Pointer   // DWORD* in/out
): BOOL; stdcall;
  external 'USER32.dll' name 'ShutdownBlockReasonQuery';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ShutdownBlockReasonQuery"
  c_ShutdownBlockReasonQuery :: Ptr () -> CWString -> Ptr Word32 -> IO CInt
-- hWnd : HWND -> Ptr ()
-- pwszBuff : LPWSTR optional, out -> CWString
-- pcchBuff : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shutdownblockreasonquery =
  foreign "ShutdownBlockReasonQuery"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr uint32_t) @-> returning int32_t)
(* hWnd : HWND -> (ptr void) *)
(* pwszBuff : LPWSTR optional, out -> (ptr uint16_t) *)
(* pcchBuff : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("ShutdownBlockReasonQuery" shutdown-block-reason-query :convention :stdcall) :int32
  (h-wnd :pointer)   ; HWND
  (pwsz-buff :pointer)   ; LPWSTR optional, out
  (pcch-buff :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ShutdownBlockReasonQuery = Win32::API::More->new('USER32',
    'BOOL ShutdownBlockReasonQuery(HANDLE hWnd, LPWSTR pwszBuff, LPVOID pcchBuff)');
# my $ret = $ShutdownBlockReasonQuery->Call($hWnd, $pwszBuff, $pcchBuff);
# hWnd : HWND -> HANDLE
# pwszBuff : LPWSTR optional, out -> LPWSTR
# pcchBuff : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。