BroadcastSystemMessageExW 関数 (winuser.h)

  • [アーティクル]

指定した受信者にメッセージを送信します。 受信者は、アプリケーション、インストール可能なドライバー、ネットワーク ドライバー、システム レベルのデバイス ドライバー、またはこれらのシステム コンポーネントの任意の組み合わせにすることができます。

この関数は BroadcastSystemMessage に似ていますが、この関数は受信者からより多くの情報を返すことができる点を除きます。

構文

long BroadcastSystemMessageExW(
  [in]                DWORD    flags,
  [in, out, optional] LPDWORD  lpInfo,
  [in]                UINT     Msg,
  [in]                WPARAM   wParam,
  [in]                LPARAM   lParam,
  [out, optional]     PBSMINFO pbsmInfo
);

パラメーター

[in] flags

型: DWORD

ブロードキャスト オプション。 このパラメーターには、次の 1 つ以上の値を指定できます。

値 意味
BSF_ALLOWSFW
0x00000080
 受信者がメッセージの処理中にフォアグラウンド ウィンドウを設定できるようにします。
BSF_FLUSHDISK
0x00000004
 各受信者がメッセージを処理した後、ディスクをフラッシュします。
BSF_FORCEIFHUNG
0x00000020
 タイムアウト期間が経過した場合、または受信者の 1 人が応答していない場合でも、メッセージのブロードキャストを続行します。
BSF_IGNORECURRENTTASK
0x00000002
 現在のタスクに属するウィンドウにメッセージを送信しません。 これにより、アプリケーションが独自のメッセージを受信できなくなります。
BSF_LUID
0x00000400
 BSF_LUIDが設定されている場合、メッセージは、BSMINFO 構造体の luid メンバーで指定されたのと同じ LUID を持つウィンドウに送信されます。

Windows 2000: このフラグはサポートされていません。
BSF_NOHANG
0x00000008
 応答しないアプリケーションを強制的にタイムアウトします。受信者の 1 人がタイムアウトした場合は、メッセージのブロードキャストを続行しないでください。
BSF_NOTIMEOUTIFNOTHUNG
0x00000040
 受信者が応答しない限り、メッセージへの応答を待機します。 タイムアウトしません。
BSF_POSTMESSAGE
0x00000010
 メッセージを投稿します。 BSF_QUERYと組み合わせて使用しないでください。
BSF_RETURNHDESK
0x00000200
 アクセスが拒否され、この とBSF_QUERY の両方が設定されている場合、 BSMINFO はデスクトップ ハンドルとウィンドウ ハンドルの両方を返します。 アクセスが拒否され、 BSF_QUERY のみが設定されている場合、ウィンドウ ハンドルのみが BSMINFO によって返されます。

Windows 2000: このフラグはサポートされていません。
BSF_QUERY
0x00000001
 メッセージを一度に 1 人の受信者に送信し、現在の受信者が TRUE を返す場合にのみ、後続の受信者に送信します。
BSF_SENDNOTIFYMESSAGE
0x00000100
 SendNotifyMessage 関数を使用してメッセージを送信します。 BSF_QUERYと組み合わせて使用しないでください。

[in, out, optional] lpInfo

型: LPDWORD

メッセージの受信者に関する情報を格納および受信する変数へのポインター。

関数が戻ると、この変数は、実際にメッセージを受信した受信者を識別するこれらの値の組み合わせを受け取ります。

このパラメーターが NULL の場合、関数はすべてのコンポーネントにブロードキャストされます。

このパラメーターには、次の 1 つ以上の値を指定できます。

値 意味
BSM_ALLCOMPONENTS
0x00000000
 すべてのシステム コンポーネントにブロードキャストします。
BSM_ALLDESKTOPS
0x00000010
 すべてのデスクトップにブロードキャストします。 SE_TCB_NAME特権が必要です。
BSM_APPLICATIONS
0x00000008
 アプリケーションにブロードキャストします。

[in] Msg

型: UINT

送信されるメッセージ。

システム提供のメッセージの一覧については、「 システム定義メッセージ」を参照してください。

[in] wParam

型: WPARAM

追加のメッセージ固有情報。

[in] lParam

型: LPARAM

追加のメッセージ固有情報。

[out, optional] pbsmInfo

種類: PBSMINFO

要求が拒否され、dwFlags が BSF_QUERY に設定されている場合に追加情報を含む BSMINFO 構造体へのポインター。

戻り値

型: long

関数が成功した場合、戻り値は正の値になります。

関数がメッセージをブロードキャストできない場合、戻り値は –1 です。

dwFlags パラメーターがBSF_QUERYで、対応するメッセージに少なくとも 1 人の受信者がBROADCAST_QUERY_DENY返された場合、戻り値は 0 になります。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

BSF_QUERYが指定されていない場合、関数は、要求されたすべての受信者に指定されたメッセージを送信し、それらの受信者から返された値を無視します。

呼び出し元のスレッドが、要求を拒否したウィンドウ以外のデスクトップ上にある場合、呼び出し元は SetThreadDesktop(hdesk) を呼び出して、そのウィンドウ上の何かを照会する必要があります。 また、呼び出し元は、返された hdesk ハンドルで CloseDesktop を呼び出す必要があります。

システムは、システム メッセージ (0 ~ (WM_USER-1) の範囲) に対してのみマーシャリングを実行します。 他のメッセージ (これらの >= WM_USER) を別のプロセスに送信するには、カスタム マーシャリングを実行する必要があります。

注意

winuser.h ヘッダーは BroadcastSystemMessageEx をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー winuser.h (Windows.h を含む)
Library User32.lib
[DLL] User32.dll

こちらもご覧ください

BSMINFO

BroadcastSystemMessage

概念

メッセージとメッセージ キュー

リファレンス

SendNotifyMessage