Fungsi WTSSendMessageA (wtsapi32.h)

Artikel
03/08/2023

Menampilkan kotak pesan pada desktop klien dari sesi Layanan Desktop Jauh tertentu.

Sintaks

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
);

Parameter

[in] hServer

Handel ke server Host Sesi RD. Tentukan handel yang dibuka oleh fungsi WTSOpenServer , atau tentukan WTS_CURRENT_SERVER_HANDLE untuk menunjukkan server Host Sesi RD tempat aplikasi Anda berjalan.

[in] SessionId

Pengidentifikasi sesi Layanan Desktop Jarak Jauh. Untuk menunjukkan sesi saat ini, tentukan WTS_CURRENT_SESSION. Anda dapat menggunakan fungsi WTSEnumerateSessions untuk mengambil pengidentifikasi semua sesi di server Host Sesi RD tertentu.

Untuk mengirim pesan ke sesi pengguna lain, Anda harus memiliki izin Pesan. Untuk informasi selengkapnya, lihat Layanan Desktop Jarak Jauh
Izin. Untuk mengubah izin pada sesi, gunakan alat administratif Konfigurasi Layanan Desktop Jarak Jauh.

[in] pTitle

Penunjuk ke string yang dihentikan null untuk bilah judul kotak pesan.

[in] TitleLength

Panjangnya, dalam byte, dari string bilah judul.

[in] pMessage

Penunjuk ke string yang dihentikan null yang berisi pesan yang akan ditampilkan.

[in] MessageLength

Panjangnya, dalam byte, dari string pesan.

[in] Style

Konten dan perilaku kotak pesan. Nilai ini biasanya MB_OK. Untuk daftar lengkap nilai, lihat parameter uType dari fungsi MessageBox .

[in] Timeout

Waktu, dalam hitungan detik, bahwa fungsi WTSSendMessage menunggu respons pengguna. Jika pengguna tidak merespons dalam interval waktu habis, parameter pResponse mengembalikan IDTIMEOUT. Jika parameter Batas Waktu adalah nol, WTSSendMessage menunggu tanpa batas waktu bagi pengguna untuk merespons.

[out] pResponse

Penunjuk ke variabel yang menerima respons pengguna, yang bisa menjadi salah satu nilai berikut.

IDABORT (3)

Batalkan

IDCANCEL (2)

Batalkan

IDCONTINUE (11)

Continue

IDIGNORE (5)

Abaikan

IDNO (7)

Tidak

IDOK (1)

IDRETRY (4)

Coba lagi

IDTRYAGAIN (10)

Coba lagi

IDYES (6)

IDASYNC (32001 (0x7D01))

Parameter bWaitadalah FALSE, sehingga fungsi dikembalikan tanpa menunggu respons.

IDTIMEOUT (32000 (0x7D00))

Parameter bWaitTRUE dan interval waktu habis berlalu.

[in] bWait

Jika TRUE, WTSSendMessage tidak kembali sampai pengguna merespons atau interval waktu habis berlalu. Jika parameter Batas Waktu adalah nol, fungsi tidak kembali sampai pengguna merespons.

Jika FALSE, fungsi segera kembali dan parameter pResponse mengembalikan IDASYNC. Gunakan metode ini untuk pesan informasi sederhana (seperti mencetak pesan pekerjaan–pemberitahuan) yang tidak perlu mengembalikan respons pengguna terhadap program panggilan.

Menampilkan nilai

Jika fungsi berhasil, nilai yang dikembalikan adalah nilai bukan nol.

Jika fungsi gagal, nilai yang dikembalikan adalah nol. Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError.

Keterangan

Catatan

Header wtsapi32.h mendefinisikan WTSSendMessage sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta praprosedur UNICODE. Mencampur penggunaan alias encoding-netral dengan kode yang tidak mengodekan-netral dapat menyebabkan ketidakcocokan yang mengakibatkan kesalahan kompilasi atau runtime. Untuk informasi selengkapnya, lihat Konvensi untuk Prototipe Fungsi.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows Vista
Server minimum yang didukung	Windows Server 2008
Target Platform	Windows
Header	wtsapi32.h
Pustaka	Wtsapi32.lib
DLL	Wtsapi32.dll

Lihat juga

Kotak Pesan

Bagikan melalui