NtFsControlFile 函数（ntifs.h）

项目
12/21/2024

NtFsControlFile 例程将控制代码直接发送到指定的文件系统或文件系统筛选器驱动程序，从而导致相应的驱动程序执行指定的操作。

语法

__kernel_entry NTSYSCALLAPI NTSTATUS NtFsControlFile(
  [in]            HANDLE           FileHandle,
  [in, optional]  HANDLE           Event,
  [in, optional]  PIO_APC_ROUTINE  ApcRoutine,
  [in, optional]  PVOID            ApcContext,
  [out]           PIO_STATUS_BLOCK IoStatusBlock,
  [in]            ULONG            FsControlCode,
  [in, optional]  PVOID            InputBuffer,
  [in]            ULONG            InputBufferLength,
  [out, optional] PVOID            OutputBuffer,
  [in]            ULONG            OutputBufferLength
);

参数

[in] FileHandle

NtCreateFile 或 NtOpenFile 返回的句柄，表示要对其执行指定操作的文件或目录的文件对象。如果调用方指定事件、ApcRoutine和 APC 上下文（ApcContext），或完成上下文（ApcContext），则必须为异步 I/O 打开文件对象。

[in, optional] Event

调用方创建的事件句柄。如果提供了此参数，则调用方将进入等待状态，直到请求的操作完成并且给定的事件设置为 Signaled 状态。此参数是可选的，可以是 NULL。如果调用方将等待 FileHandle 设置为 Signaled 状态，则该参数必须为 NULL。

[in, optional] ApcRoutine

请求的操作完成时要调用的调用方提供的 APC 例程的地址。此参数是可选的，可以是 NULL。如果存在与文件对象关联的 I/O 完成对象，则该参数必须为 NULL。

[in, optional] ApcContext

指向调用方确定的上下文区域的指针。如果调用方提供 APC，则此参数值用作 APC 上下文，或者当 I/O 完成对象与文件对象关联时用作完成上下文。操作完成后，APC 上下文将传递到 APC（如果已指定），或者完成上下文包含在 I/O 管理器发布到关联的 I/O 完成对象的完成消息中。

此参数是可选的，可以是 NULL。如果 ApcRoutine 为 NULL，并且没有与文件对象关联的 I/O 完成对象，则该参数必须为 NULL。

[out] IoStatusBlock

指向接收最终完成状态和有关操作信息的IO_STATUS_BLOCK结构的指针。对于返回数据的成功调用，将在此结构的信息成员中返回写入 OutputBuffer 的字节数。

[in] FsControlCode

FSCTL_XXX 代码，用于指示要执行哪个文件系统控制操作。此参数的值确定 InputBuffer 和 OutputBuffer的格式和所需长度，以及以下哪些参数对是必需的。有关系统定义FSCTL_XXX 代码的详细信息，请参阅 DeviceIoControl参考条目的“备注”部分。

[in, optional] InputBuffer

指向调用方分配的输入缓冲区的指针，该缓冲区包含要提供给目标驱动程序的设备特定信息。如果 FsControlCode 指定不需要输入数据的操作，则此指针是可选的，可以是 NULL。

[in] InputBufferLength

InputBuffer处缓冲区的大小（以字节为单位）。如果 InputBuffer 为 NULL，则忽略此值。

[out, optional] OutputBuffer

指向调用方分配的输出缓冲区的指针，在该缓冲区中从目标驱动程序返回信息。如果 FsControlCode 指定不生成输出数据的操作，则此指针是可选的，可以是 NULL。

[in] OutputBufferLength

OutputBuffer处缓冲区的大小（以字节为单位）。如果 OutputBuffer 为 NULL，则忽略此值。

返回值

NtFsControlFile 返回STATUS_SUCCESS或相应的 NTSTATUS 值，例如以下值之一：

言论

NtFsControlFile 为系统和内核模式驱动程序提供输入和输出数据的一致视图，同时为应用程序和基础驱动程序提供依赖于驱动程序的方法来指定通信接口。

如果调用方为异步 I/O 打开文件（未FILE_SYNCHRONOUS_XXX 创建/打开选项集），则指定事件（如果有）将在设备控制操作完成时设置为信号状态。否则，FileHandle 指定的文件对象将设置为信号状态。如果指定了 ApcRoutine，则会使用 ApcContext 和 IoStatusBlock 指针调用它。

下面是为内核模式驱动程序记录的一些 FSCTL 代码：

有关系统定义FSCTL_XXX 代码的详细信息，请参阅 DeviceIoControl参考条目的“备注”部分。

有关系统定义IOCTL_XXX 代码以及定义特定于驱动程序的 IOCTL_XXX 或 FSCTL_XXX 值的详细信息，请参阅使用 I/O 控制代码和设备输入和输出控制代码。

微型筛选器应使用 FltFsControlFile 而不是 NtFsControlFile。

NtFsControlFile 的调用方必须在 IRQL = PASSIVE_LEVEL，并且启用了特殊内核 APC 的 **。

如果在用户模式下调用 NtFsControlFile 函数，则应使用名称“NtFsControlFile”而不是“ZwFsControlFile”。

对于内核模式驱动程序的调用，NtXXX 和 ZwXXX 版本的 Windows 本机系统服务例程的行为方式可能以处理和解释输入参数的方式不同。有关 NtXXX 与 ZwXXX 例程版本之间的关系的详细信息，请参阅使用 Nt 和 Zw 版本的本机系统服务例程。

要求

要求	价值
最低支持的客户端	Windows 2000
目标平台	普遍
标头	ntifs.h （include Ntifs.h）
库	NtosKrnl.lib
DLL	NtosKrnl.exe
IRQL	PASSIVE_LEVEL（请参阅“备注”部分）
DDI 符合性规则	HwStorPortProhibitedDDI、PowerIrpDDis