WTSSendMessageA 関数 (wtsapi32.h)

[アーティクル]
11/20/2024

指定したリモートデスクトップサービスセッションのクライアントデスクトップにメッセージボックスを表示します。

構文

BOOL WTSSendMessageA(
  [in]  HANDLE hServer,
  [in]  DWORD  SessionId,
  [in]  LPSTR  pTitle,
  [in]  DWORD  TitleLength,
  [in]  LPSTR  pMessage,
  [in]  DWORD  MessageLength,
  [in]  DWORD  Style,
  [in]  DWORD  Timeout,
  [out] DWORD  *pResponse,
  [in]  BOOL   bWait
);

パラメーター

[in] hServer

RD セッションホストサーバーへのハンドル。 WTSOpenServer 関数によって開かれたハンドルを指定するか、アプリケーションが実行されている RD セッションホストサーバーを示す WTS_CURRENT_SERVER_HANDLE を指定します。

[in] SessionId

リモートデスクトップサービスセッション識別子。現在のセッションを示すには、WTS_CURRENT_SESSIONを指定します。 WTSEnumerateSessions 関数を使用して、指定された RD セッションホストサーバー上のすべてのセッションの識別子を取得できます。

別のユーザーのセッションにメッセージを送信するには、メッセージのアクセス許可が必要です。詳細については、「リモートデスクトップサービスの」を参照してください。
アクセス許可。セッションのアクセス許可を変更するには、リモートデスクトップサービス構成管理ツールを使用します。

[in] pTitle

メッセージボックスのタイトルバーの null で終わる文字列へのポインター。

[in] TitleLength

タイトルバー文字列の長さ (バイト単位)。

[in] pMessage

表示するメッセージを含む null で終わる文字列へのポインター。

[in] MessageLength

メッセージ文字列の長さ (バイト単位)。

[in] Style

メッセージボックスの内容と動作。通常、この値は MB_OKです。値の完全な一覧については、MessageBox 関数の uType パラメーターを参照してください。

[in] Timeout

WTSSendMessage 関数がユーザーの応答を待機する時間 (秒単位)。ユーザーがタイムアウト期間内に応答しない場合、pResponse パラメーターは IDTIMEOUT返します。 Timeout パラメーターが 0 の場合、WTSSendMessage ユーザーが応答するまで無期限に待機します。

[out] pResponse

ユーザーの応答を受け取る変数へのポインター。次のいずれかの値を指定できます。

IDABORT (3)

中止

IDCANCEL (2)

キャンセル

IDCONTINUE (11)

Continue

IDIGNORE (5)

無視

IDNO (7)

なし

IDOK (1)

IDRETRY (4)

再試行

IDTRYAGAIN (10)

再試行

IDYES (6)

はい

IDASYNC (32001 (0x7D01))

bWait パラメーターは FALSEされたため、応答を待たずに関数が返されました。

IDTIMEOUT (32000 (0x7D00))

bWait パラメーターが TRUE され、タイムアウト間隔が経過しました。

[in] bWait

TRUE場合、WTSSendMessage は、ユーザーが応答するか、タイムアウト間隔が経過するまで戻りません。 Timeout パラメーターが 0 の場合、ユーザーが応答するまで関数は戻りません。

FALSE場合、関数はすぐに戻り、pResponse パラメーターは IDASYNC返します。このメソッドは、ユーザーの応答を呼び出し元のプログラムに返す必要のない単純な情報メッセージ (ジョブ通知メッセージの印刷など) に使用します。

戻り値

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

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

備考

手記

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

必要条件

要件	価値
サポートされる最小クライアント	Windows Vista
サポートされる最小サーバー	Windows Server 2008
ターゲットプラットフォームの	ウィンドウズ
ヘッダー	wtsapi32.h
ライブラリ	Wtsapi32.lib
DLL	Wtsapi32.dll

次の方法で共有