ホーム › System.Shutdown › ShutdownBlockReasonQuery

ShutdownBlockReasonQuery

関数

ウィンドウに登録されたシャットダウン阻止理由を取得する。

DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

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

パラメーター

名前	型	方向	説明
hWnd	HWND	in	アプリケーションのメインウィンドウへのハンドル。
pwszBuff	LPWSTR	outoptional	理由文字列を受け取るバッファーへのポインター。このパラメーターが NULL の場合、関数は理由文字列の文字数を取得します。
pcchBuff	DWORD*	inout	pwszBuff バッファーのサイズを文字単位で指定する変数へのポインター。関数が成功した場合、この変数にはバッファーにコピーされた文字数が格納されます(null 終端文字を含む)。バッファーが小さすぎる場合、この変数には必要なバッファーサイズが文字単位で格納されます(null 終端文字は含まない)。

戻り値の型: BOOL

公式ドキュメント

ShutdownBlockReasonCreate 関数によって設定された理由文字列を取得します。

戻り値

呼び出しが成功した場合、戻り値は 0 以外です。

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

解説(Remarks)

この関数は、hWnd パラメーターで指定されたウィンドウを作成したスレッドからのみ呼び出すことができます。それ以外の場合、関数は失敗し、最終エラーコードは ERROR_ACCESS_DENIED になります。

例

次の例では、必要なバッファーサイズを取得し、理由文字列用のメモリを割り当て、理由文字列を取得して、その文字列をデバッグ出力として表示します。

#include <windows.h>

#pragma comment(lib, "User32.lib")

HWND hWnd;

BOOL DisplayShutdownBlockReason()
{
    DWORD cch=0;

    if (ShutdownBlockReasonQuery(hWnd, NULL, &cch)) 
    { 
        WCHAR *pch = (WCHAR *)LocalAlloc(LMEM_FIXED, cch * sizeof(*pch)); 
        if (NULL != pch) 
        { 
            if (ShutdownBlockReasonQuery(hWnd, pch, &cch)) 
            { 
                OutputDebugStringW(L"Shutdown block reason: "); 
                OutputDebugStringW(pch); 
                OutputDebugStringW(L"\n"); 
            } 
            LocalFree(pch); 
            return TRUE;
        } 
    }
    return FALSE;
}

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

各言語での呼び出し定義

// 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 方式にも切替可。#uselib "USER32.dll"
#cfunc global ShutdownBlockReasonQuery "ShutdownBlockReasonQuery" sptr, sptr, sptr
; res = ShutdownBlockReasonQuery(hWnd, varptr(pwszBuff), varptr(pcchBuff))
; hWnd : HWND -> "sptr"
; pwszBuff : LPWSTR optional, out -> "sptr"
; pcchBuff : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。