Fungsi SetupWriteTextLog (setupapi.h)

Artikel
03/15/2023

Fungsi SetupWriteTextLog menulis entri log dalam log teks SetupAPI.

Sintaks

WINSETUPAPI VOID SetupWriteTextLog(
  [in] SP_LOG_TOKEN LogToken,
  [in] DWORD        Category,
  [in] DWORD        Flags,
  [in] PCSTR        MessageStr,
       ...          
);

Parameter

[in] LogToken

Token log yang merupakan token log yang ditentukan sistem atau dikembalikan oleh SetupGetThreadLogToken.

[in] Category

Nilai jenis DWORD yang menunjukkan kategori peristiwa untuk entri log. Kategori peristiwa yang dapat ditentukan untuk entri log sama dengan yang dapat diaktifkan untuk log teks. Untuk daftar kategori peristiwa, lihat Mengaktifkan Kategori Peristiwa untuk Log Teks SetupAPI.

[in] Flags

Nilai berjenis DWORD yang merupakan bitwise ATAU nilai bendera, yang menentukan hal berikut:

Tingkat peristiwa untuk entri log. Tingkat peristiwa yang dapat ditentukan untuk entri log sama dengan yang dapat diaktifkan untuk log teks. Untuk daftar bendera tingkat peristiwa, lihat Mengatur Tingkat Peristiwa untuk Log Teks SetupAPI.
Apakah akan menyertakan stempel waktu dalam entri log. Nilai bendera stempel waktu TXTLOG_TIMESTAMP.
Perubahan, jika ada, ke kedalaman indentasi bagian dan entri log saat ini. Untuk informasi tentang cara menggunakan bendera indentasi, lihat Menulis Entri Log Inden.

[in] MessageStr

Penunjuk ke string konstanta yang dihentikan NULL yang berisi string format yang kompatibel dengan printf, yang menentukan pesan yang diformat untuk disertakan dalam entri log. Daftar parameter yang dipisahkan koma yang mengikuti MessageStr harus cocok dengan penentu format dalam string format.

...

Daftar parameter yang dipisahkan koma yang cocok dengan penentu format dalam string format yang disediakan oleh MessageStr.

Mengembalikan nilai

Tidak ada

Keterangan

Jika nilai LogToken dikembalikan oleh panggilan ke SetupGetThreadLogToken dan bagian log teks terkait dapat ditemukan, SetupWriteTextLog menulis entri log di bagian log teks tersebut. Jika SetupWriteTextLog tidak dapat menemukan bagian , SetupWriteTextLog menulis entri log di log teks terkait, tetapi tidak menyertakan entri log dalam bagian.

Jika nilai LogToken adalah salah satu token log yang ditentukan sistem yang tercantum dalam tabel berikut, SetupWriteTextLog melakukan operasi tulis yang ditunjukkan untuk token log tersebut.

Token log yang ditentukan sistem	Operasi tulis
LOGTOKEN_NOLOG	Entri log tidak ditulis ke log teks apa pun.
LOG_TOKEN_UNSPECIFIED	Entri log ditulis ke log teks penginstalan aplikasi. Entri log tidak disertakan dalam bagian log teks.
LOGTOKEN_SETUPAPI_APPLOG	Entri log ditulis ke log teks penginstalan aplikasi. Entri log tidak disertakan dalam bagian log teks.
LOGTOKEN_SETUPAPI_DEVLOG	Entri log ditulis ke log teks penginstalan perangkat. Entri log tidak disertakan dalam bagian log teks.

Catatan Mengatur nilai LogToken ke salah satu token log yang ditentukan sistem tidak mengubah nilai token log saat ini untuk utas.

Selain itu, SetupWriteTextLog tidak menulis entri log ketika salah satu hal berikut ini benar:

Tingkat peristiwa yang diatur untuk log teks kurang dari tingkat peristiwa yang ditentukan untuk entri log.
Kategori peristiwa untuk entri log tidak diaktifkan untuk log teks. Untuk informasi selengkapnya tentang kategori peristiwa, lihat Mengaktifkan Kategori Peristiwa untuk Log Teks.

Panjang maksimum, dalam karakter, dari entri log adalah 336.

Untuk menulis informasi tentang kesalahan khusus SetupAPI atau kesalahan Win32 dalam log teks, aplikasi dapat menggunakan SetupWriteTextLogError.

Untuk informasi umum tentang menulis entri log di log teks SetupAPI, lihat SetupAPI Logging (Windows Vista dan Later).

Untuk informasi selengkapnya tentang operasi SetupWriteTextLog, lihat Memanggil SetupWriteTextLog.

Untuk informasi selengkapnya tentang token log, lihat Token Log.

Untuk informasi selengkapnya tentang menggunakan token log, lihat Mengatur dan Mendapatkan Token Log untuk Utas.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Tersedia di Windows Vista dan versi Windows yang lebih baru.
Target Platform	Desktop
Header	setupapi.h (termasuk Setupapi.h)
Pustaka	Setupapi.lib
Set API	ext-ms-win-setupapi-logging-l1-1-0 (diperkenalkan dalam Windows 8)

Lihat juga

SetupGetThreadLogToken

SetupWriteTextLogError

Bagikan melalui