WdfDeviceInitAssignName-Funktion (wdfdevice.h)

[Gilt nur für KMDF]

Die WdfDeviceInitAssignName-Methode weist dem Geräteobjekt eines Geräts einen Gerätenamen zu.

Syntax

NTSTATUS WdfDeviceInitAssignName(
  [in]           PWDFDEVICE_INIT  DeviceInit,
  [in, optional] PCUNICODE_STRING DeviceName
);

Parameter

[in] DeviceInit

Ein Zeiger auf eine WDFDEVICE_INIT-Struktur .

[in, optional] DeviceName

Ein Zeiger auf eine UNICODE_STRING-Struktur , die den Gerätenamen darstellt.

Rückgabewert

Wenn WdfDeviceInitAssignName keine Fehler aufweist, wird STATUS_SUCCESS zurückgegeben. Weitere Rückgabewerte sind:

Rückgabecode Beschreibung
STATUS_INSUFFICIENT_RESOURCES
Das System kann keinen Speicherplatz zum Speichern des Gerätenamens zuweisen.

Hinweise

Wenn ein Treiber WdfDeviceInitAssignName aufruft, muss er dies tun, bevor er WdfDeviceCreate aufruft.

Wenn ein Treiber WdfDeviceInitAssignName aufruft, um einen Namen zuzuweisen, kann der Treiber anschließend WdfDeviceInitAssignName mit einem NULLDeviceName-Parameter aufrufen, um den Gerätenamen zu löschen. Wenn der Gerätename NULL ist und das Geräteobjekt einen Namen erfordert (da es ein PDO oder ein Steuergerät darstellt), erstellt das Betriebssystem einen Namen.

Weitere Informationen zum Benennen von Geräteobjekten finden Sie unter Steuern des Gerätezugriffs in Framework-Based Treibern.

Weitere Informationen zum Aufrufen von WdfDeviceCreate finden Sie unter Erstellen eines Framework-Geräteobjekts.

Beispiele

Im folgenden Codebeispiel wird einem Gerät ein NT-Gerätename zugewiesen.

DECLARE_CONST_UNICODE_STRING(MyDeviceName, L"\\Device\\Ramdisk") ;
status = WdfDeviceInitAssignName(
                                 DeviceInit,
                                 &MyDeviceName
                                 );
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 Versionierung der Frameworkbibliothek.)
IRQL PASSIVE_LEVEL
DDI-Complianceregeln ChildDeviceInitAPI(kmdf), ControlDeviceInitAPI(kmdf), DeviceInitAPI(kmdf), DriverCreate(kmdf), InitFreeDeviceCallback(kmdf), InitFreeDeviceCreate(kmdf), InitFreeNull(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), PdoDeviceInitAPI(kmdf), PdoInitFreeDeviceCallback(kmdf), PdoInitFreeDeviceCreate(kmdf)

Weitere Informationen

WdfDeviceRetrieveDeviceName