ホーム › UI.Shell › SHQueryUserNotificationState

SHQueryUserNotificationState

関数

通知表示が可能かを示すユーザー通知状態を取得する。

DLLSHELL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT SHQueryUserNotificationState(
    QUERY_USER_NOTIFICATION_STATE* pquns
);

パラメーター

名前	型	方向	説明
pquns	QUERY_USER_NOTIFICATION_STATE*	out	この関数が返るとき、QUERY_USER_NOTIFICATION_STATE 列挙体の値のいずれかへのポインターを格納します。

戻り値の型: HRESULT

公式ドキュメント

現在のユーザーに対して通知を送信することが適切かどうかを判断するために、コンピューターの状態を確認します。

戻り値

型: HRESULT

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

アプリケーションは、Shell_NotifyIcon によって生成されるバルーン通知に類似した通知 UI を表示する前に、SHQueryUserNotificationState を呼び出して戻り値を確認する必要があります。通知は、この API が QNS_ACCEPTS_NOTIFICATIONS を返した場合にのみ表示すべきです。これにより、中断すべきでないプロセスをユーザーが実行しているかどうかをアプリケーションに通知します。トップレベルウィンドウは、ユーザーがプレゼンテーション設定をオンまたはオフにしたとき、およびユーザーのセッションがロックまたはロック解除されたときに WM_SETTINGCHANGE メッセージを受け取ります。ユーザーがフルスクリーンアプリケーションを開始または終了したときには通知が送信されないことに注意してください。

この関数が QUNS_QUIET_TIME を返した場合、通知は重要な場合にのみ表示すべきです。

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

各言語での呼び出し定義

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

HRESULT SHQueryUserNotificationState(
    QUERY_USER_NOTIFICATION_STATE* pquns
);

[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHQueryUserNotificationState(
    out int pquns   // QUERY_USER_NOTIFICATION_STATE* out
);

<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHQueryUserNotificationState(
    <Out> ByRef pquns As Integer   ' QUERY_USER_NOTIFICATION_STATE* out
) As Integer
End Function

' pquns : QUERY_USER_NOTIFICATION_STATE* out
Declare PtrSafe Function SHQueryUserNotificationState Lib "shell32" ( _
    ByRef pquns As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHQueryUserNotificationState = ctypes.windll.shell32.SHQueryUserNotificationState
SHQueryUserNotificationState.restype = ctypes.c_int
SHQueryUserNotificationState.argtypes = [
    ctypes.c_void_p,  # pquns : QUERY_USER_NOTIFICATION_STATE* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHQueryUserNotificationState = Fiddle::Function.new(
  lib['SHQueryUserNotificationState'],
  [
    Fiddle::TYPE_VOIDP,  # pquns : QUERY_USER_NOTIFICATION_STATE* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn SHQueryUserNotificationState(
        pquns: *mut i32  // QUERY_USER_NOTIFICATION_STATE* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll")]
public static extern int SHQueryUserNotificationState(out int pquns);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHQueryUserNotificationState' -Namespace Win32 -PassThru
# $api::SHQueryUserNotificationState(pquns)

#uselib "SHELL32.dll"
#func global SHQueryUserNotificationState "SHQueryUserNotificationState" sptr
; SHQueryUserNotificationState varptr(pquns)   ; 戻り値は stat
; pquns : QUERY_USER_NOTIFICATION_STATE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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