WdfDeviceRetrieveDeviceName-Funktion (wdfdevice.h)
[Gilt nur für KMDF]
Die WdfDeviceRetrieveDeviceName-Methode gibt den Gerätenamen für ein angegebenes Gerät zurück.
Syntax
NTSTATUS WdfDeviceRetrieveDeviceName(
[in] WDFDEVICE Device,
[in] WDFSTRING String
);
Parameter
[in] Device
Ein Handle für ein Framework-Geräteobjekt.
[in] String
Ein Handle für ein Frameworkzeichenfolgenobjekt, das den Gerätenamen empfängt.
Rückgabewert
Wenn der Vorgang erfolgreich ist, gibt WdfDeviceRetrieveDeviceName STATUS_SUCCESS zurück. Weitere Rückgabewerte sind:
| Rückgabecode | Beschreibung |
|---|---|
|
Ein ungültiger Parameter wurde erkannt. |
Die -Methode gibt möglicherweise andere NTSTATUS-Werte zurück.
Eine Fehlerüberprüfung tritt auf, wenn der Treiber ein ungültiges Objekthandle bereitstellt.
Hinweise
Die WdfDeviceRetrieveDeviceName-Methode gibt den Gerätenamen zurück, den der Treiber in einem vorherigen Aufruf von WdfDeviceInitAssignName angegeben hat.
Um die Gerätenamenzeichenfolge aus dem Zeichenfolgenobjekt abzurufen, kann der Treiber WdfStringGetUnicodeString aufrufen.
Beispiele
Im folgenden Codebeispiel wird ein Zeichenfolgenobjekt erstellt und dann der Name eines angegebenen Geräts abgerufen.
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;
}
}
Anforderungen
| Anforderung | Wert |
|---|---|
| Zielplattform | Universell |
| KMDF-Mindestversion | 1.0 |
| Kopfzeile | wdfdevice.h (einschließen von Wdf.h) |
| Bibliothek | Wdf01000.sys (siehe Versionsverwaltung der Frameworkbibliothek).) |
| IRQL | PASSIVE_LEVEL |
| DDI-Complianceregeln | DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf) |