Fungsi EnumDesktopsA (winuser.h)

Artikel
08/27/2023

Menghitung semua desktop yang terkait dengan stasiun jendela yang ditentukan dari proses panggilan. Fungsi ini meneruskan nama setiap desktop, pada gilirannya, ke fungsi panggilan balik yang ditentukan aplikasi.

Sintaks

BOOL EnumDesktopsA(
  [in, optional] HWINSTA          hwinsta,
  [in]           DESKTOPENUMPROCA lpEnumFunc,
  [in]           LPARAM           lParam
);

Parameter

[in, optional] hwinsta

Handel ke stasiun jendela yang desktopnya akan dijumlahkan. Handel ini dikembalikan oleh fungsi CreateWindowStation, GetProcessWindowStation, atau OpenWindowStation , dan harus memiliki hak akses WINSTA_ENUMDESKTOPS. Untuk informasi selengkapnya, lihat Keamanan dan Hak Akses Window Station.

Jika parameter ini NULL, stasiun jendela saat ini digunakan.

[in] lpEnumFunc

Penunjuk ke fungsi panggilan balik EnumDesktopProc yang ditentukan aplikasi.

[in] lParam

Nilai yang ditentukan aplikasi untuk diteruskan ke fungsi panggilan balik.

Mengembalikan nilai

Jika fungsi berhasil, fungsi mengembalikan nilai bukan nol yang dikembalikan oleh fungsi panggilan balik yang diacu oleh lpEnumFunc.

Jika fungsi tidak dapat melakukan enumerasi, nilai yang dikembalikan adalah nol. Panggil GetLastError untuk mendapatkan informasi kesalahan yang diperluas.

Jika fungsi panggilan balik gagal, nilai yang dikembalikan adalah nol. Fungsi panggilan balik dapat memanggil SetLastError untuk mengatur kode kesalahan agar pemanggil dapat mengambil dengan memanggil GetLastError.

Keterangan

Fungsi EnumDesktops hanya menghitung desktop yang proses panggilannya memiliki hak akses DESKTOP_ENUMERATE. Untuk informasi selengkapnya, lihat Keamanan Desktop dan Hak Akses.

Fungsi EnumDesktops berulang kali memanggil fungsi panggilan balik lpEnumFunc hingga desktop terakhir dijumlahkan atau fungsi panggilan balik mengembalikan FALSE.

Catatan

Header winuser.h mendefinisikan EnumDesktops sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta pra-prosesor 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


Klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	winuser.h (termasuk Windows.h)
Pustaka	User32.lib
DLL	User32.dll