Fungsi WdfDeviceRetrieveDeviceName (wdfdevice.h)

  • Artikel

[Hanya berlaku untuk KMDF]

Metode WdfDeviceRetrieveDeviceName mengembalikan nama perangkat untuk perangkat tertentu.

Sintaks

NTSTATUS WdfDeviceRetrieveDeviceName(
  [in] WDFDEVICE Device,
  [in] WDFSTRING String
);

Parameter

[in] Device

Handel ke objek perangkat kerangka kerja.

[in] String

Handel ke objek string kerangka kerja yang menerima nama perangkat.

Nilai kembali

Jika operasi berhasil, WdfDeviceRetrieveDeviceName mengembalikan STATUS_SUCCESS. Nilai pengembalian tambahan meliputi:

Menampilkan kode Deskripsi
STATUS_INVALID_PARAMETER
 Parameter yang tidak valid terdeteksi.
 

Metode ini mungkin mengembalikan nilai NTSTATUS lainnya.

Pemeriksaan bug terjadi jika driver menyediakan handel objek yang tidak valid.

Keterangan

Metode WdfDeviceRetrieveDeviceName mengembalikan nama perangkat yang ditentukan driver dalam panggilan sebelumnya ke WdfDeviceInitAssignName.

Untuk mendapatkan string nama perangkat dari objek string, driver dapat memanggil WdfStringGetUnicodeString.

Contoh

Contoh kode berikut membuat objek string lalu mengambil nama perangkat tertentu.

NTSTATUS status;
WDFSTRING string;

status = WdfStringCreate(
                         NULL,
                         WDF_NO_OBJECT_ATTRIBUTES,
                         &string
                         );
if (NT_SUCCESS(status)) {
    status = WdfDeviceRetrieveDeviceName(
                                         Device,
                                         string
                                         );
    if (!NT_SUCCESS(status)) {
        return status;
    }
}

Persyaratan

Persyaratan Nilai
Target Platform Universal
Versi KMDF minimum 1,0
Header wdfdevice.h (termasuk Wdf.h)
Pustaka Wdf01000.sys (lihat Penerapan Versi Pustaka Kerangka Kerja.)
IRQL PASSIVE_LEVEL
Aturan kepatuhan DDI DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

Lihat juga

WdfDeviceInitAssignName

WdfDeviceQueryProperty

WdfStringCreate