Fungsi SetupGetStringFieldW (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 SetupGetStringField mengambil string dari bidang baris yang ditentukan dalam file INF.

Sintaksis

WINSETUPAPI BOOL SetupGetStringFieldW(
  [in]      PINFCONTEXT Context,
  [in]      DWORD       FieldIndex,
  [in, out] PWSTR       ReturnBuffer,
  [in]      DWORD       ReturnBufferSize,
  [out]     PDWORD      RequiredSize
);

Parameter

[in] Context

Penunjuk ke konteks untuk baris dalam file INF.

[in] FieldIndex

Indeks berbasis 1 dari bidang dalam baris yang ditentukan tempat string harus diambil. Gunakan FieldIndex 0 untuk mengambil kunci string, jika ada.

[in, out] ReturnBuffer

Penunjuk opsional ke buffer yang menerima stringnull dihentikan. Anda harus memastikan buffer tujuan berukuran sama atau lebih besar dari buffer sumber. Parameter ini dapat null. Lihat bagian Komentar.

[in] ReturnBufferSize

Ukuran buffer yang diacu oleh ReturnBuffer , dalam karakter. Ini termasuk terminator null .

[out] RequiredSize

Penunjuk opsional ke variabel yang menerima ukuran yang diperlukan untuk buffer yang ditunjukkan oleh parameter ReturnBuffer, dalam karakter. Jika ReturnBuffer ditentukan dan ukuran aktual yang diperlukan lebih besar dari nilai yang ditentukan oleh ReturnBufferSize, fungsi gagal dan tidak menyimpan string dalam buffer. Dalam hal ini, panggilan ke GetLastError mengembalikan ERROR_INSUFFICIENT_BUFFER. Untuk versi Unicode dari fungsi ini, ukuran yang diperlukan dalam karakter. Ini termasuk 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 ReturnBuffer NULL dan ReturnBufferSize nol, fungsi menempatkan ukuran buffer yang diperlukan untuk menyimpan data yang ditentukan ke dalam variabel yang diacu 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.

Anda dapat memanggil fungsi sekali untuk mendapatkan ukuran buffer yang diperlukan, mengalokasikan memori yang diperlukan, lalu memanggil fungsi untuk kedua kalinya untuk mengambil data. Dengan menggunakan teknik ini, Anda dapat menghindari kesalahan karena ukuran buffer yang tidak memadai.

Perhatikan bahwa panjang maksimum string tunggal yang ditentukan di bagian String INF adalah 512 karakter, termasuk penghentian NULL. Jika panjang string lebih besar dari 512, panjang string akan dipotong dan tidak ada kesalahan yang akan dikembalikan. Panjang maksimum string yang digabungkan yang dibuat dari satu atau beberapa token %strkey% adalah 4096 karakter.

Nota

Header setupapi.h mendefinisikan SetupGetStringField sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta preprosektor 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
set API	ext-ms-win-setupapi-inf-l1-1-1 (diperkenalkan di Windows 10, versi 10.0.14393)

Lihat juga

Functions

Gambaran Umum

SetupGetBinaryField

SetupGetIntField

SetupGetMultiSzField