Fungsi GetConsoleProcessList
Mengambil daftar proses yang dilampirkan ke konsol saat ini.
Sintaks
DWORD WINAPI GetConsoleProcessList(
_Out_ LPDWORD lpdwProcessList,
_In_ DWORD dwProcessCount
);
Parameter
lpdwProcessList [out]
Penunjuk ke buffer yang menerima array pengidentifikasi proses setelah berhasil. Ini harus berupa buffer yang valid dan tidak boleh NULL. Buffer harus memiliki ruang untuk menerima setidaknya 1 id proses yang dikembalikan.
dwProcessCount [in]
Jumlah maksimum pengidentifikasi proses yang dapat disimpan dalam buffer lpdwProcessList . Ini harus lebih besar dari 0.
Nilai hasil
Jika fungsi berhasil, nilai pengembalian kurang dari atau sama dengan dwProcessCount dan mewakili jumlah pengidentifikasi proses yang disimpan dalam buffer lpdwProcessList .
Jika buffer terlalu kecil untuk menahan semua pengidentifikasi proses yang valid, nilai pengembalian adalah jumlah elemen array yang diperlukan. Fungsi ini tidak akan menyimpan pengidentifikasi di buffer. Dalam situasi ini, gunakan nilai pengembalian untuk mengalokasikan buffer yang cukup besar untuk menyimpan seluruh daftar dan memanggil fungsi lagi.
Jika nilai pengembalian adalah nol, fungsi telah gagal, karena setiap konsol memiliki setidaknya satu proses yang terkait dengannya. Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError.
NULL Jika daftar proses disediakan atau jumlah proses adalah 0, panggilan akan mengembalikan 0 dan GetLastError akan mengembalikan ERROR_INVALID_PARAMETER. Harap sediakan buffer setidaknya satu elemen untuk memanggil fungsi ini. Alokasikan buffer yang lebih besar dan panggil lagi jika kode pengembalian lebih besar dari panjang buffer yang disediakan.
Keterangan
Untuk mengkompilasi aplikasi yang menggunakan fungsi ini, tentukan _WIN32_WINNT sebagai 0x0501 atau yang lebih baru. Untuk informasi selengkapnya, lihat Menggunakan Header Windows.
Tip
API ini tidak disarankan dan tidak memiliki terminal virtual yang setara. Keputusan ini sengaja menyelaraskan platform Windows dengan sistem operasi lainnya. Status ini hanya relevan dengan konteks pengguna, sesi, dan hak istimewa lokal. Aplikasi jarak jauh melalui utilitas lintas platform dan transportasi seperti SSH mungkin tidak berfungsi seperti yang diharapkan jika menggunakan API ini.
Persyaratan
| Klien minimum yang didukung | Windows XP [hanya aplikasi desktop] |
| Server minimum yang didukung | Windows Server 2003 [hanya aplikasi desktop] |
| Header | ConsoleApi3.h (melalui WinCon.h, termasuk Windows.h) |
| Pustaka | Kernel32.lib |
| DLL | Kernel32.dll |