Metode IWDFDevice::RetrieveDeviceInstanceId (wudfddi.h)

Artikel
08/08/2023

[Peringatan: UMDF 2 adalah versi terbaru UMDF dan pengganti UMDF 1. Semua driver UMDF baru harus ditulis menggunakan UMDF 2. Tidak ada fitur baru yang ditambahkan ke UMDF 1 dan ada dukungan terbatas untuk UMDF 1 pada versi Windows 10 yang lebih baru. Driver Universal Windows harus menggunakan UMDF 2. Untuk informasi selengkapnya, lihat Mulai menggunakan UMDF.]

Metode RetrieveDeviceInstanceId mengambil pengidentifikasi instans perangkat.

Sintaks

HRESULT RetrieveDeviceInstanceId(
  [out, optional] PWSTR Buffer,
  [in, out]       DWORD *pdwSizeInChars
);

Parameter

[out, optional] Buffer

Penunjuk ke buffer yang menerima string yang dihentikan NULL yang mewakili pengidentifikasi instans perangkat, jika buffer yang disediakan non-NULL dan RetrieveDeviceInstanceId berhasil.

[in, out] pdwSizeInChars

Penunjuk ke variabel yang menerima jumlah karakter, termasuk karakter NULL , dalam string yang dirujuk Buffer .

Jika BufferADALAH NULL, nilai yang disediakan driver adalah nol. Kerangka kerja kemudian mengembalikan ukuran, dalam karakter, yang diperlukan untuk string pengidentifikasi.

Jika Buffer bukan NULL, kerangka kerja mengembalikan ukuran, dalam karakter, dari string pengidentifikasi.

Nilai kembali

RetrieveDeviceInstanceId mengembalikan S_OK untuk skenario berikut:

Buffer yang ditunjukkan parameter Buffer adalah non-NULL dan cukup besar untuk menahan string pengidentifikasi, termasuk karakter NULL , dan kerangka kerja berhasil menyalin string ke dalam buffer yang disediakan dan mengatur variabel yang ditunjukkan oleh parameter pdwSizeInChars ke jumlah karakter dalam string.
Buffer di Buffer adalah NULL, driver mengatur variabel di pdwSizeInChars ke 0, dan kerangka kerja mengatur variabel di pdwSizeInChars ke jumlah karakter yang diperlukan untuk string.

RetrieveDeviceInstanceId mengembalikan HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) untuk menunjukkan bahwa buffer yang disediakan non-NULL dan tidak berisi cukup ruang untuk menahan string pengidentifikasi. Kerangka kerja mengatur variabel di pdwSizeInChars ke jumlah karakter yang diperlukan untuk string.

RetrieveDeviceInstanceId mungkin juga mengembalikan nilai HRESULT lainnya.

Persyaratan

Persyaratan	Nilai
Akhir dukungan	Tidak tersedia di UMDF 2.0 dan yang lebih baru.
Target Platform	Desktop
Versi UMDF minimum	1,5
Header	wudfddi.h (termasuk Wudfddi.h)
DLL	WUDFx.dll

Lihat juga

IWDFDevice