FltWriteFile-Funktion (fltkernel.h)

Artikel
11/16/2023

FltWriteFile wird verwendet, um Daten auf eine geöffnete Datei, einen Stream oder ein gerät zu schreiben.

Syntax

NTSTATUS FLTAPI FltWriteFile(
  [in]            PFLT_INSTANCE                    InitiatingInstance,
  [in]            PFILE_OBJECT                     FileObject,
  [in, optional]  PLARGE_INTEGER                   ByteOffset,
  [in]            ULONG                            Length,
  [in]            PVOID                            Buffer,
  [in]            FLT_IO_OPERATION_FLAGS           Flags,
  [out, optional] PULONG                           BytesWritten,
  [in, optional]  PFLT_COMPLETED_ASYNC_IO_CALLBACK CallbackRoutine,
  [in, optional]  PVOID                            CallbackContext
);

Parameter

[in] InitiatingInstance

Ein undurchsichtiger instance Zeiger für den Minifiltertreiber instance, an den der Vorgang gesendet werden soll. Die instance muss an das Volume angefügt werden, in dem sich die Datei befindet. Dieser Parameter ist erforderlich und darf nicht NULL sein.

[in] FileObject

Zeiger auf einen FILE_OBJECT für die Datei, in die die Daten geschrieben werden sollen. Dieses Dateiobjekt muss derzeit geöffnet sein. Das Aufrufen von FltWriteFile , wenn das Dateiobjekt noch nicht geöffnet ist oder nicht mehr geöffnet ist (z. B. in einer Rückrufroutine vor oder nach der Bereinigung), führt dazu, dass das System für einen überprüften Build ASSERT erhält. Dieser Parameter ist erforderlich und darf nicht NULL sein.

[in, optional] ByteOffset

Zeiger auf eine vom Aufrufer zugewiesene Variable, die den Anfangsbyteoffset in der Datei angibt, in der der Lesevorgang beginnen soll.

Wenn ByteOffset angegeben ist, wird die E/A an diesem Offset ausgeführt, unabhängig vom aktuellen Wert des Felds CurrentByteOffset des Dateiobjekts.

Wenn die Datei für synchrone E/A geöffnet wurde (FO_SYNCHRONOUS_IO im Feld Flags des Dateiobjekts festgelegt ist), kann der Aufrufer ByteOffset-LowPart> auf FILE_USE_FILE_POINTER_POSITION und ByteOffset-HighPart> auf -1 festlegen, damit die E/A im CurrentByteOffset-Feld des Dateiobjekts ausgeführt wird. Wenn die Datei nicht für synchrone E/A-Vorgänge geöffnet wurde, ist die Verwendung FILE_USE_FILE_POINTER_POSITION ein Fehler.
Der Aufrufer kann ByteOffset-LowPart> auf FILE_WRITE_TO_END_OF_FILE und ByteOffset-HighPart> auf -1 festlegen, um den Schreibvorgang am Ende der Datei zu starten (d. h. einen anfügenden Schreibvorgang ausführen).

Wenn ByteOffset nicht angegeben ist:

Wenn die Datei nicht für synchrone E/A-Vorgänge geöffnet wurde, ist dies ein Fehler.
Andernfalls wird die E/A am CurrentByteOffset des Dateiobjekts ausgeführt.

Wenn das Dateiobjekt für synchrone E/A geöffnet wurde, wird das CurrentByteOffset-Feld aktualisiert, es sei denn, der Aufrufer übergibt das flag FLTFL_IO_OPERATION_DO_NOT_UPDATE_BYTE_OFFSET.

Hinweis: In diesem Fall aktualisiert das Dateisystem weiterhin CurrentByteOffset . Der Filter-Manager speichert den Wert CurrentByteOffset vor dem Senden der E/A im Stapel und stellt ihn wieder her, wenn die E/A zurückgibt. Aus sicht des Aufrufers von FltWriteFile (und Filter in höheren Höhen) wird das CurrrentByteOffset nicht aktualisiert. Filter unter dem Aufrufer sehen jedoch den aktualisierten CurrentByteOffset-Wert in ihren Rückrufen nach Lese-/Schreibzugriff.

Wenn das Dateiobjekt nicht für synchrone E/A-Vorgänge geöffnet wurde, wird das Feld CurrentByteOffset unabhängig vom Zustand des ByteOffset-Parameters nicht aktualisiert.

Wenn das Dateiobjekt, auf das FileObject verweist, für asynchrone E/A-Vorgänge geöffnet wurde, ist dieser Parameter erforderlich und kann nicht NULL sein.

Vor Windows 8 werden die speziellen Konstanten FILE_WRITE_TO_END_OF_FILE und FILE_USE_FILE_POINTER_POSITION für diesen Parameter nicht unterstützt.

[in] Length

Größe des Puffers in Bytes, auf den der Buffer-Parameter verweist.

[in] Buffer

Zeiger auf einen Puffer, der die Daten enthält, die in die Datei geschrieben werden sollen. Wenn die Datei für nicht zwischengespeicherte E/A-Vorgänge geöffnet wird, muss dieser Puffer gemäß der Ausrichtungsanforderung des zugrunde liegenden Speichergeräts ausgerichtet werden. Minifiltertreiber können einen solchen ausgerichteten Puffer zuordnen, indem sie FltAllocatePoolAlignedWithTag aufrufen.

[in] Flags

Bitmaske von Flags, die den Typ des auszuführenden Schreibvorgangs angeben.

Flag	Bedeutung
FLTFL_IO_OPERATION_DO_NOT_UPDATE_BYTE_OFFSET	Minifiltertreiber können dieses Flag festlegen, um anzugeben, dass FltWriteFile das CurrentByteOffset-Feld des Dateiobjekts nicht aktualisiert.
FLTFL_IO_OPERATION_NON_CACHED	Minifiltertreiber können dieses Flag festlegen, um einen nicht zwischengespeicherten Schreibvorgang anzugeben, auch wenn das Dateiobjekt nicht mit FILE_NO_INTERMEDIATE_BUFFERING geöffnet wurde.
FLTFL_IO_OPERATION_PAGING	Minifiltertreiber können dieses Flag festlegen, um einen Pagingschreibvorgang anzugeben.
FLTFL_IO_OPERATION_SYNCHRONOUS_PAGING	Minifiltertreiber können dieses Flag festlegen, um einen synchronen Auslagerungs-E/A-Schreibvorgang anzugeben. Minifiltertreiber, die dieses Flag festlegen, müssen auch das FLTFL_IO_OPERATION_PAGING-Flag festlegen. Dieses Flag ist ab Windows Vista verfügbar.

[out, optional] BytesWritten

Zeiger auf eine vom Aufrufer zugewiesene Variable, die die Anzahl der in die Datei geschriebenen Bytes empfängt. Wenn CallbackRoutine nicht NULL ist, wird dieser Parameter ignoriert. Andernfalls ist dieser Parameter optional und kann NULL sein.

[in, optional] CallbackRoutine

Zeiger auf eine PFLT_COMPLETED_ASYNC_IO_CALLBACK typisierte Rückrufroutine, um nach Abschluss des Schreibvorgangs aufzurufen. Dieser Parameter ist optional und kann NULL sein.

[in, optional] CallbackContext

Kontextzeiger, der an callbackRoutine übergeben werden soll, falls vorhanden. Dieser Parameter ist optional und kann NULL sein. Wenn CallbackRoutine NULL ist, wird dieser Parameter ignoriert.

Rückgabewert

FltWriteFile gibt den NTSTATUS-Wert zurück, der vom Dateisystem zurückgegeben wurde.

Hinweise

Ein Minifiltertreiber ruft FltWriteFile auf, um Daten in eine geöffnete Datei zu schreiben.

FltWriteFile bewirkt, dass eine Schreibanforderung an die Minifiltertreiberinstanzen gesendet wird, die unterhalb der initiierenden instance und an das Dateisystem angefügt sind. Die angegebene instance und die darüber angefügten Instanzen empfangen die Schreibanforderung nicht.

FltWriteFile führt nicht zwischengespeicherte E/A-Vorgänge aus, wenn einer der folgenden Punkte zutrifft:

Der Aufrufer hat das FLTFL_IO_OPERATION_NON_CACHED-Flag im Flags-Parameter festgelegt.
Das Dateiobjekt wurde für nicht zwischengespeicherte E/A-Vorgänge geöffnet. In der Regel erfolgt dies durch Angabe des FILE_NO_INTERMEDIATE_BUFFERING CreateOptions-Flags im vorherigen Aufruf von FltCreateFile, FltCreateFileEx oder ZwCreateFile.

Nicht zwischengespeicherte E/A-Vorgänge erzwingen die folgenden Einschränkungen für die Parameterwerte, die an FltWriteFile übergeben werden:

Der Puffer, auf den der Pufferparameter verweist, muss entsprechend der Ausrichtungsanforderung des zugrunde liegenden Speichergeräts ausgerichtet werden. Um einen solchen ausgerichteten Puffer zuzuweisen, rufen Sie FltAllocatePoolAlignedWithTag auf.
Der Byteoffset-Offset, auf den der ByteOffset-Parameter verweist, muss ein nicht-negatives Vielfaches der Sektorgröße des Volumes sein.
Die im Length-Parameter angegebene Länge muss ein nicht bestimmtes Vielfaches der Sektorgröße des Volumes sein.

Wenn der Wert des CallbackRoutine-Parameters nicht NULL ist, wird der Schreibvorgang asynchron ausgeführt.

Wenn der Wert des CallbackRoutine-Parameters NULL ist, wird der Schreibvorgang synchron ausgeführt. Das heißt, FltWriteFile wartet, bis der Schreibvorgang abgeschlossen ist, bevor er zurückgegeben wird. Dies gilt auch dann, wenn das Dateiobjekt, auf das FileObject verweist, für asynchrone E/A-Vorgänge geöffnet wurde.

Wenn mehrere Threads FltWriteFile für dasselbe Dateiobjekt aufrufen und das Dateiobjekt für synchrone E/A-Vorgänge geöffnet wurde, versucht der Filter-Manager nicht, E/A für die Datei zu serialisieren. In dieser Hinsicht unterscheidet sich FltWriteFile von ZwWriteFile.