Edit

FS_BPIO_RESULTS structure (ntifs.h)

  • Article

The FS_BPIO_RESULTS structure defines BypassIO operation-specific outputs for FS_BPIO_OP_ENABLE and FS_BPIO_OP_QUERY operations when a driver is failing the operation.

Syntax

typedef struct _FS_BPIO_RESULTS {
  NTSTATUS OpStatus;
  USHORT   FailingDriverNameLen;
  WCHAR    FailingDriverName[32];
  USHORT   FailureReasonLen;
  WCHAR    FailureReason[128];
} FS_BPIO_RESULTS, *PFS_BPIO_RESULTS;

Members

OpStatus

Receives a NTSTATUS code available to the caller that identifies why the failing driver cannot support BypassIO for this file. This field should only be set by the first driver to fail the enable/query request.

FailingDriverNameLen

Receives the length of the string stored in FailingDriverName, in characters.

FailingDriverName[32]

Receives a string that specifies the name of the driver that failed the request. For diagnostic reasons, a driver must store its name when it fails a FS_BPIO_OP_ENABLE or FS_BPIO_OP_QUERY operation. The name must match the actual name of the driver that is used by the system; for example, ntfs.sys. This string is not guaranteed to be NULL-terminated.

FailureReasonLen

Receives the length of the string stored in FailingReason, in characters.

FailureReason[128]

Receives a unique, descriptive string describing why the driver vetoed the enable/query request. This string is used for diagnostic reasons, and should be in English so that it does not need to be localized. This string is not guaranteed to be NULL-terminated.

Remarks

FS_BPIO_RESULTS is returned in the FS_BPIO_OPERATIONS structure when a driver fails an enable or query BypassIO operation.

See BypassIO for filter drivers and Supporting BypassIO operations for more information.

Requirements

Requirement Value
Minimum supported client Windows 11
Header ntifs.h

See also

FS_BPIO_OPERATIONS

FSCTL_MANAGE_BYPASS_IO