Fungsi PdhVbOpenLog

Fungsi PdhVbOpenLog membuka file log yang ditentukan untuk membaca dan menulis. Fungsi ini memanggil PdhOpenLog.

Penting

Fungsi yang dijelaskan topik ini dapat diubah atau tidak tersedia di masa mendatang. Sebagai gantinya, Microsoft menyarankan agar Anda menggunakan fungsi yang dijelaskan dalam Fungsi Penghitung Kinerja.

Fungsi PdhVbOpenLog( _ ByVal szLogFileName As LPCTSTR, _ ByVal dwAccessFlags As DWORD, _ ByVal lpdwLogType As LPDWORD, _ ByVal hQuery As PDH_HQUERY, _ ByVal dwMaxSize As DWORD, _ ByVal szUserCaption As LPCSTR, _ ByRef phLog As PDH_HLOG _ ) As DWORD

Parameter

szLogFileName [in]

Penunjuk ke string yang menentukan nama file log yang akan dibuka.

Jika file log berisi data SQL, format nama file log adalah **SQL:DataSourceName!**LogFileName. Dalam hal ini, nilai parameter lpdwLogType PDH_LOG_TYPE_SQL.

dwAccessFlags [in]

Jenis akses yang akan ditentukan ketika file log dibuka. Parameter ini bisa menjadi salah satu nilai berikut.

Nilai	Makna
PDH_LOG_READ_ACCESS	File log dibuka untuk operasi baca.
PDH_LOG_WRITE_ACCESS	File log baru dibuka untuk operasi tulis.
PDH_LOG_UPDATE_ACCESS	File log yang ada dibuka untuk operasi tulis.

Nilai yang dipilih dari tabel sebelumnya dapat digabungkan menggunakan operator OR dengan salah satu bendera buat akses berikut.

Nilai	Makna
PDH_LOG_CREATE_NEW	File log baru dengan nama yang ditentukan dibuat.
PDH_LOG_CREATE_ALWAYS	File log baru dengan nama yang ditentukan dibuat dan file log yang ada dengan nama yang sama dihapus.
PDH_LOG_OPEN_EXISTING	File log yang ada dengan nama yang ditentukan dibuka. Jika file log dengan nama yang ditentukan tidak ada, ini sama dengan PDH_LOG_CREATE_NEW.
PDH_LOG_OPEN_ALWAYS	File log yang ada dengan nama yang ditentukan dibuka atau file log baru dengan nama yang ditentukan dibuat.

lpdwLogType [in]

Penunjuk ke variabel yang menunjukkan jenis file log yang akan dibuka. Parameter ini bisa menjadi salah satu nilai berikut.

Nilai	Makna
PDH_LOG_TYPE_UNDEFINED	Format file log yang tidak ditentukan.
PDH_LOG_TYPE_CSV	File teks yang berisi header kolom di baris pertama, dan sampel data individual di setiap baris berikutnya.
PDH_LOG_TYPE_SQL	Data dalam file log ada di SQL.
PDH_LOG_TYPE_TSV	Sama seperti PDH_LOG_TYPE_CSV.
PDH_LOG_TYPE_BINARY	Format file log biner. Termasuk file log melingkar.
PDH_LOG_TYPE_PERFMON	Format file log Perfmon.

hQuery [in]

Handel kueri. Handel ini dikembalikan oleh fungsi PdhVbOpenQuery .

Parameter ini dapat berupa NULL jika file log akan dibuka untuk dibaca.

dwMaxSize [in]

Ukuran maksimum file log, dalam byte. Nilai ini hanya digunakan jika file log adalah file log berukuran terbatas atau melingkar.

szUserCaption [in]

Penunjuk ke string yang menentukan caption file log yang ditentukan pengguna. File log caption umumnya menjelaskan konten file log. Ketika file log yang ada dibuka, nilai parameter ini diabaikan.

phLog [in, ref]

Penunjuk ke buffer yang menerima handel ke file log yang dibuka.

Mengembalikan nilai

Jika fungsi berhasil, fungsi akan mengembalikan 0.

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

Menampilkan kode	Deskripsi
PDH_INSUFFICIENT_BUFFER	Data yang diminta lebih besar dari buffer yang disediakan. Tidak dapat mengembalikan data yang diminta.
PDH_INVALID_ARGUMENT	Satu atau beberapa buffer string bukan ukuran yang benar.
PDH_INVALID_HANDLE	Handel bukanlah objek PDH yang valid.
PDH_LOG_FILE_OPEN_ERROR	Tidak dapat membuka file log yang ditentukan.
PDH_FILE_NOT_FOUND	Tidak dapat menemukan file yang ditentukan.

Keterangan

Saat menggunakan fungsi ini untuk menulis data performa ke file log, kueri harus terlebih dahulu dibuka menggunakan PdhVbOpenQuery.

Harus ada kueri yang saat ini dibuka, dan penghitung yang diinginkan harus ditambahkan ke dalamnya, sebelum fungsi ini dipanggil.

Perhatikan bahwa file log dalam format Perfmon hanya dapat dibuka untuk dibaca.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows XP [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Pustaka	Pdh.lib
DLL	Pdh.dll

Lihat juga

PdhOpenLog

PdhVbGetLogFileSize

PdhVbUpdateLog