Fungsi SetupQueryFileLogA (setupapi.h)

[Fungsi ini tersedia untuk digunakan dalam sistem operasi yang ditunjukkan di bagian Persyaratan. Ini mungkin diubah atau tidak tersedia dalam versi berikutnya. SetupAPI tidak boleh lagi digunakan untuk menginstal aplikasi. Sebagai gantinya, gunakan Penginstal Windows untuk mengembangkan penginstal aplikasi. PenyetelanAPI terus digunakan untuk menginstal pengandar perangkat.]

Fungsi SetupQueryFileLog mengembalikan informasi dari log file penyiapan.

Sintaksis

WINSETUPAPI BOOL SetupQueryFileLogA(
  [in]      HSPFILELOG       FileLogHandle,
  [in]      PCSTR            LogSectionName,
  [in]      PCSTR            TargetFilename,
  [in]      SetupFileLogInfo DesiredInfo,
  [in, out] PSTR             DataOut,
  [in]      DWORD            ReturnBufferSize,
  [in, out] PDWORD           RequiredSize
);

Parameter

[in] FileLogHandle

Tangani ke log file seperti yang dikembalikan oleh SetupInitializeFileLog.

[in] LogSectionName

Penunjuk opsional ke nama bagian untuk file log dalam format yang bermakna bagi pemanggil. Anda harus menggunakan stringnullyang dihentikan . Diperlukan untuk log non-sistem. Jika tidak ada LogSectionName yang ditentukan untuk log sistem, default disediakan.

[in] TargetFilename

Nama file yang informasi lognya diinginkan. Anda harus menggunakan stringnullyang dihentikan .

[in] DesiredInfo

Menunjukkan informasi apa yang harus dikembalikan ke buffer DataOut . Parameter ini bisa menjadi salah satu nilai enumerasi berikut.

Nilai	Arti
nama SetupFileLogSourceFile	Nama file sumber seperti yang ada di media sumber
SetupFileLogChecksum	Nilai checksum yang digunakan oleh log sistem
SetupFileLogDiskTagfile	Nama file tag sumber media yang berisi file sumber
SetupFileLogDiskDescription	Deskripsi media yang dapat dibaca manusia tempat file sumber berada
SetupFileLogOtherInfo	Informasi tambahan yang terkait dengan file yang dicatat

 

Jika nilai DesiredInfo lebih besar dari SetupFileLogOtherInfo fungsi akan gagal, dan GetLastError akan mengembalikan ERROR_INVALID_PARAMETER.

[in, out] DataOut

Penunjuk opsional ke buffer tempat fungsi ini mengembalikan informasi yang diminta untuk file. Anda harus menggunakan stringnullyang dihentikan . String null-dihentikan tidak boleh melebihi ukuran buffer tujuan. Anda dapat memanggil fungsi sekali untuk mendapatkan ukuran buffer yang diperlukan, mengalokasikan memori yang diperlukan, lalu memanggil fungsi untuk kedua kalinya untuk mengambil data. Lihat bagian Komentar. Dengan menggunakan teknik ini, Anda dapat menghindari kesalahan karena ukuran buffer yang tidak memadai. Tidak semua informasi disediakan untuk setiap file. Kesalahan tidak dikembalikan jika entri kosong untuk file ada di log. Parameter ini dapat null.

[in] ReturnBufferSize

Ukuran buffer DataOut , dalam karakter. Ini termasuk terminator null . Jika buffer terlalu kecil dan dataOut ditentukan, data tidak disimpan dalam buffer dan fungsi mengembalikan nol. Jika DataOut tidak ditentukan, parameter ReturnBufferSize diabaikan.

[in, out] RequiredSize

Penunjuk opsional ke variabel yang menerima ukuran DataOut yang diperlukan, dalam karakter. Angka ini mencakup terminator null .

Mengembalikan nilai

Jika fungsi berhasil, nilai yang dikembalikan adalah nilai bukan nol.

Jika fungsi gagal, nilai yang dikembalikan adalah nol. Untuk mendapatkan informasi kesalahan yang diperluas, panggil GetLastError.

Komentar

Jika fungsi ini dipanggil dengan DataOut NULL dan ReturnBufferSize nol, fungsi menempatkan ukuran buffer yang diperlukan untuk menyimpan data yang ditentukan ke dalam variabel yang ditunjukkan oleh RequiredSize. Jika fungsi berhasil dalam hal ini, nilai yang dikembalikan adalah nilai bukan nol. Jika tidak, nilai yang dikembalikan adalah nol dan informasi kesalahan yang diperluas dapat diperoleh dengan memanggil GetLastError.

Jika nilai DesiredInfo lebih besar dari SetupFileLogOtherInfo fungsi akan gagal, dan GetLastError akan mengembalikan ERROR_INVALID_PARAMETER.

Nota

Header setupapi.h mendefinisikan SetupQueryFileLog sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta praprosesor 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	setupapi.h
Pustaka	Setupapi.lib
DLL	Setupapi.dll

Lihat juga

Functions

Gambaran Umum

SetupLogFile