WdfFileObjectGetFileName-Funktion (wdffileobject.h)

  • Artikel

[Gilt für KMDF und UMDF]

Die WdfFileObjectGetFileName-Methode gibt den Dateinamen zurück, den ein angegebenes Frameworkdateiobjekt enthält.

Syntax

PUNICODE_STRING WdfFileObjectGetFileName(
  [in] WDFFILEOBJECT FileObject
);

Parameter

[in] FileObject

Ein Handle für ein Frameworkdateiobjekt.

Rückgabewert

WdfFileObjectGetFileName gibt einen Zeiger auf eine UNICODE_STRING-Struktur zurück, die den Dateinamen enthält. Die -Methode gibt NULL zurück, wenn kein WDM-Dateiobjekt für das angegebene Frameworkdateiobjekt vorhanden ist oder wenn es bei einem IRQL-Wert aufgerufen wird, der höher als PASSIVE_LEVEL ist.

Eine Fehlerüberprüfung tritt auf, wenn der Treiber ein ungültiges Objekthandle bereitstellt.

Hinweise

Wenn ein Treiber beim Aufrufen von WdfDeviceCreateDeviceInterface eine Verweiszeichenfolge angegeben hat, gibt WdfFileObjectGetFileName die Verweiszeichenfolge zurück, die durch einen umgekehrten Schrägstrich vorangestellt wird. Um die Verweiszeichenfolge zu bestimmen, entfernen Sie den umgekehrten Schrägstrich.

Die zurückgegebene Zeichenfolge kann einen Dateinamen oder eine Verweiszeichenfolge enthalten. Die Zeichenfolge enthält nicht den Gerätenamen. Wenn eine Anwendung oder Kernelmoduskomponente das Gerät anstelle einer Datei ohne Verweiszeichenfolge geöffnet hat, ist der Length-Member der zurückgegebenen UNICODE_STRING-Struktur null.

Ihr Treiber sollte nur WdfFileObjectGetFileName aufrufen, während er eine Dateierstellungsanforderung (WdfRequestTypeCreate-Anforderungstyp ) verarbeitet. Ihr Treiber verarbeitet möglicherweise WdfRequestTypeCreate-typisierte E/A-Anforderungen in einer EvtDeviceFileCreate-Rückruffunktion .

Oder anstatt eine EvtDeviceFileCreate-Rückruffunktion bereitzustellen, kann der Treiber WdfDeviceConfigureRequestDispatching aufrufen, um eine E/A-Warteschlange festzulegen, um alle Anforderungen zur Dateierstellung zu empfangen (WdfRequestTypeCreate-Anforderungstyp ). Der Treiber empfängt anschließend Dateierstellungsanforderungen im EvtIoDefault-Anforderungshandler der Warteschlange.

Weitere Informationen zu Frameworkdateiobjekten finden Sie unter Framework-Dateiobjekte.

Weitere Informationen zu Dateinamen finden Sie unter Steuern des Gerätenamespacezugriffs.

Weitere Informationen zu Verweiszeichenfolgen finden Sie unter IoRegisterDeviceInterface.

Beispiele

Das folgende Codebeispiel zeigt, wie eine EvtDeviceFileCreate-Rückruffunktion den Namen der Datei abrufen kann, die von einer Anwendung geöffnet wurde.

VOID
MyEvtDeviceFileCreate (
    IN WDFDEVICE  Device,
    IN WDFREQUEST  Request,
    IN WDFFILEOBJECT  FileObject
    )
{
    PUNICODE_STRING  fileName;

    fileName = WdfFileObjectGetFileName(FileObject);
...

}

Anforderungen

Anforderung Wert
Zielplattform Universell
KMDF-Mindestversion 1.0
UMDF-Mindestversion 2.0
Kopfzeile wdffileobject.h (include Wdf.h)
Bibliothek Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
IRQL PASSIVE_LEVEL
DDI-Complianceregeln DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

Weitere Informationen

UNICODE_STRING

WdfDeviceCreateDeviceInterface