WTSSendMessageA 関数 (wtsapi32.h)
指定したリモート デスクトップ サービス セッションのクライアント デスクトップにメッセージ ボックスを表示します。
構文
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 関数によって開かれたハンドルを指定するか、WTS_CURRENT_SERVER_HANDLEを指定して、アプリケーションが実行されている RD セッション ホスト サーバーを示します。
[in] SessionId
リモート デスクトップ サービスのセッション識別子。 現在のセッションを示すには、 WTS_CURRENT_SESSIONを指定します。 WTSEnumerateSessions 関数を使用して、指定された RD セッション ホスト サーバー上のすべてのセッションの識別子を取得できます。
別のユーザーのセッションにメッセージを送信するには、メッセージアクセス許可が必要です。 詳細については、「リモート デスクトップ サービス」を参照してください 。
Permissions]\(次へ: アクセス許可\) をクリックします。 セッションのアクセス許可を変更するには、リモート デスクトップ サービス構成管理ツールを使用します。
[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)
続行
IDIGNORE (5)
無視
IDNO (7)
No
IDOK (1)
[OK]
IDRETRY (4)
Retry
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 |
対象プラットフォーム | Windows |
ヘッダー | wtsapi32.h |
Library | Wtsapi32.lib |
[DLL] | Wtsapi32.dll |