WdfDeviceRetrieveDeviceName-Funktion (wdfdevice.h)

Artikel
02/07/2025

[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 zu einem Framework-Geräteobjekt.

[in] String

Ein Handle für ein Framework-Zeichenfolgenobjekt, 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
STATUS_INVALID_PARAMETER	Ein ungültiger Parameter wurde erkannt.

Die Methode gibt möglicherweise andere NTSTATUS-Wertezurück.

Wenn der Treiber ein ungültiges Objekthandle bereitstellt, tritt eine Fehlerüberprüfung auf.

Bemerkungen

Die WdfDeviceRetrieveDeviceName Methode gibt den Gerätenamen zurück, den der treiber in einem vorherigen Aufruf von WdfDeviceInitAssignNameangegeben hat.

Um die Gerätenamenzeichenfolge aus dem Zeichenfolgenobjekt abzurufen, kann der Treiber WdfStringGetUnicodeString-aufrufen.

Beispiele

Im folgenden Codebeispiel wird ein Zeichenfolgenobjekt erstellt und anschließend 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-	Universal
Minimale KMDF-Version	1.0
Header-	wdfdevice.h (einschließen Wdf.h)
Library	Wdf01000.sys (siehe Framework-Bibliotheksversionsverwaltung.)
IRQL-	PASSIVE_LEVEL
DDI-Complianceregeln	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

Siehe auch

WdfDeviceInitAssignName

WdfDeviceQueryProperty-

WdfStringCreate-

Freigeben über