ShutdownBlockReasonQuery 函式 (winuser.h)

擷取 ShutdownBlockReasonCreate 函式所設定的原因字串。

語法

BOOL ShutdownBlockReasonQuery(
  [in]            HWND   hWnd,
  [out, optional] LPWSTR pwszBuff,
  [in, out]       DWORD  *pcchBuff
);

參數

[in] hWnd

應用程式的主視窗句柄。

[out, optional] pwszBuff

接收原因字串之緩衝區的指標。 如果此參數為 NULL，函式會擷取原因字串中的字元數。

[in, out] pcchBuff

變數的指標，指定 pwszBuff 緩衝區的大小，以字元為單位。 如果函式成功，此變數會收到複製到緩衝區的字元數，包括 Null 終止字元。 如果緩衝區太小，變數會收到所需的緩衝區大小，以字元為單位，不包含 Null 終止字元。

傳回值

如果呼叫成功，則傳回值為非零值。

如果呼叫失敗，則傳回值為零。 若要取得擴充的錯誤資訊，請呼叫 GetLastError。

備註

此函式只能從建立 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;
}

規格需求

需求	值
最低支援的用戶端	Windows Vista [傳統型應用程式 |UWP 應用程式]
最低支援的伺服器	Windows Server 2008 [傳統型應用程式 |UWP 應用程式]
目標平台	Windows
標頭	winuser.h (包含 Windows.h)
程式庫	User32.lib
Dll	User32.dll

另請參閱

ShutdownBlockReasonCreate

關閉