Fungsi WTSEnumerateSessionsA (wtsapi32.h)

Artikel
03/09/2024

Mengambil daftar sesi di server Host Sesi Desktop Jarak Jauh (Host Sesi RD).

Sintaks

BOOL WTSEnumerateSessionsA(
  [in]  HANDLE             hServer,
  [in]  DWORD              Reserved,
  [in]  DWORD              Version,
  [out] PWTS_SESSION_INFOA *ppSessionInfo,
  [out] DWORD              *pCount
);

Parameter

[in] hServer

Handel ke server Host Sesi RD.

Catatan Anda dapat menggunakan fungsi WTSOpenServer atau WTSOpenServerEx untuk mengambil handel ke server tertentu, atau WTS_CURRENT_SERVER_HANDLE untuk menggunakan server Host Sesi RD yang menghosting aplikasi Anda.

[in] Reserved

Parameter ini dicadangkan. Pasti nol.

[in] Version

Versi permintaan enumerasi. Parameter ini harus 1.

[out] ppSessionInfo

Penunjuk ke array struktur WTS_SESSION_INFO yang mewakili sesi yang diambil. Untuk membebaskan buffer yang dikembalikan, panggil fungsi WTSFreeMemory .

Izin sesi:

Untuk menghitung sesi, Anda harus mengaktifkan izin informasi kueri. Untuk informasi selengkapnya, lihat Izin Layanan Desktop Jauh.
Untuk mengubah izin pada sesi, gunakan alat administratif Konfigurasi Layanan Desktop Jauh.
Untuk menghitung sesi yang berjalan pada komputer virtual yang dihosting di server Host Virtualisasi RD, Anda harus menjadi anggota grup Administrator di server Host Virtualisasi RD.

[out] pCount

Penunjuk ke jumlah struktur WTS_SESSION_INFO yang dikembalikan dalam parameter ppSessionInfo .

Nilai kembali

Mengembalikan nol jika fungsi ini gagal. Jika fungsi ini berhasil, nilai bukan nol dikembalikan.

Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError.

Keterangan

Catatan

Header wtsapi32.h mendefinisikan WTSEnumerateSessions sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta praprosesor 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
Set API	ext-ms-win-session-wtsapi32-l1-1-0 (diperkenalkan dalam Windows 8)

Lihat juga

WTS_SESSION_INFO

Bagikan melalui