Fungsi PdhGetCounterInfoW (pdh.h)

Artikel
11/20/2024

Mengambil informasi tentang penghitung, seperti ukuran data, jenis penghitung, jalur, dan nilai data yang disediakan pengguna.

Sintaksis

PDH_FUNCTION PdhGetCounterInfoW(
  [in]      PDH_HCOUNTER        hCounter,
  [in]      BOOLEAN             bRetrieveExplainText,
  [in, out] LPDWORD             pdwBufferSize,
  [out]     PPDH_COUNTER_INFO_W lpBuffer
);

Parameter

[in] hCounter

Tangani penghitung tempat Anda ingin mengambil informasi. Fungsi PdhAddCounter mengembalikan handel ini.

[in] bRetrieveExplainText

Menentukan apakah penjelasan teks diambil. Jika Anda mengatur parameter ini ke TRUE, teks penjelasan untuk penghitung diambil. Jika Anda mengatur parameter ini ke FALSE, bidang di buffer yang dikembalikan NULL.

[in, out] pdwBufferSize

Ukuran buffer lpBuffer, dalam byte. Jika nol pada input, fungsi mengembalikan PDH_MORE_DATA dan mengatur parameter ini ke ukuran buffer yang diperlukan. Jika buffer lebih besar dari ukuran yang diperlukan, fungsi mengatur parameter ini ke ukuran buffer aktual yang digunakan. Jika ukuran yang ditentukan pada input lebih besar dari nol tetapi kurang dari ukuran yang diperlukan, Anda tidak boleh mengandalkan ukuran yang dikembalikan untuk merealokasi buffer.

[out] lpBuffer

Buffer yang dialokasikan pemanggil yang menerima struktur PDH_COUNTER_INFO. Strukturnya panjang variabel, karena data string ditambahkan ke akhir bagian format tetap struktur. Ini dilakukan agar semua data dikembalikan dalam satu buffer yang dialokasikan oleh pemanggil. Atur ke NULL jika pdwBufferSize adalah nol.

Mengembalikan nilai

Jika fungsi berhasil, fungsi akan mengembalikan ERROR_SUCCESS.

Jika fungsi gagal, nilai yang dikembalikan adalah kode kesalahan sistem atau kode kesalahan PDH . Berikut ini adalah nilai yang mungkin.

Mengembalikan kode	Deskripsi
PDH_INVALID_ARGUMENT	Parameter tidak valid atau salah diformat. Misalnya, pada beberapa rilis, Anda dapat menerima kesalahan ini jika ukuran yang ditentukan pada input lebih besar dari nol tetapi kurang dari ukuran yang diperlukan.
PDH_INVALID_HANDLE	Handel penghitung tidak valid.
PDH_MORE_DATA	Buffer lpBuffer terlalu kecil untuk menyimpan informasi penghitung. Nilai pengembalian ini diharapkan jika pdwBufferSize adalah nol pada input. Jika ukuran yang ditentukan pada input lebih besar dari nol tetapi kurang dari ukuran yang diperlukan, Anda tidak boleh mengandalkan ukuran yang dikembalikan untuk merealokasi buffer.

Komentar

Anda harus memanggil fungsi ini dua kali, pertama kali untuk mendapatkan ukuran buffer yang diperlukan (atur lpBuffer ke null dan pdwBufferSize ke 0), dan kedua kalinya untuk mendapatkan data.

Nota

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

Syarat	Nilai
klien minimum yang didukung	Windows XP [hanya aplikasi desktop]
server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Platform Target	Windows
Header	pdh.h
Pustaka	Pdh.lib
DLL	Pdh.dll

Lihat juga

PDH_COUNTER_INFO

Bagikan melalui