SetupGetSourceFileLocationA (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 SetupGetSourceFileLocation mengambil lokasi file sumber yang tercantum dalam file INF.

Sintaksis

WINSETUPAPI BOOL SetupGetSourceFileLocationA(
  [in]      HINF        InfHandle,
  [in]      PINFCONTEXT InfContext,
  [in]      PCSTR       FileName,
  [in, out] PUINT       SourceId,
  [in, out] PSTR        ReturnBuffer,
  [out]     DWORD       ReturnBufferSize,
  [in, out] PDWORD      RequiredSize
);

Parameter

[in] InfHandle

Tangani ke file INF yang berisi bagian SourceDisksNames dan SourceDisksFiles. Jika bagian khusus platform ada untuk sistem pengguna (misalnya, SourceDisksNames.x86 dan SourceDisksFiles.x86), bagian khusus platform akan digunakan.

[in] InfContext

Penunjuk opsional ke konteks baris di bagian Salin File yang jalur sumber lengkapnya akan diambil. Jika parameter ini NULL , FileName dicari di bagian SourceDisksFiles dari file INF yang ditentukan oleh InfHandle.

[in] FileName

Penunjuk opsional ke string nulldihentikan yang berisi nama file (tanpa jalur) untuk mengembalikan lokasi sumber lengkap. Parameter ini dapat null, tetapi FileName atau InfContext harus ditentukan.

[in, out] SourceId

Penunjuk ke variabel yang menerima pengidentifikasi sumber media tempat file berada dari bagian SourceDisksNames dari file INF.

[in, out] ReturnBuffer

Penunjuk opsional ke buffer untuk menerima jalur sumber relatif. Jalur sumber tidak menyertakan nama file itu sendiri, juga tidak menyertakan nama huruf kandar/berbagi jaringan. Jalur tidak dimulai atau diakhir dengan garis miring terbelakang (), sehingga string kosong menentukan direktori akar. Anda harus menggunakan buffer stringnull 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. Dengan menggunakan teknik ini, Anda dapat menghindari kesalahan karena ukuran buffer yang tidak memadai. Lihat bagian Komentar. Parameter ini dapat null.

[out] ReturnBufferSize

Ukuran buffer yang diacu oleh ReturnBuffer , dalam karakter. Angka ini mencakup terminator null .

[in, out] RequiredSize

Penunjuk opsional ke variabel yang menerima ukuran yang diperlukan untuk buffer yang ditunjukkan oleh parameter ReturnBuffer, dalam karakter. Angka ini mencakup terminator null . Jika ukuran yang diperlukan lebih besar dari nilai yang ditentukan oleh ReturnBufferSize, fungsi gagal dan GetLastError mengembalikan ERROR_INSUFFICIENT_BUFFER.

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.

Nota

Header setupapi.h mendefinisikan SetupGetSourceFileLocation 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

SetupGetSourceFileSize

SetupGetSourceInfo