FSCTL_OPBATCH_ACK_CLOSE_PENDING control code

  • Article

The FSCTL_OPBATCH_ACK_CLOSE_PENDING control code responds to notification that an exclusive (level 1, batch, or filter) opportunistic lock (oplock) on a file has been broken. A client application sends this control code to indicate that it acknowledges the oplock break and it is about to close the file handle.

For a batch or filter oplock break, the caller must close its file handle after sending this control code. Otherwise, the system will block waiting for the file handle to be closed.

This control code is not intended to be used with level 1 oplocks. Nevertheless, for a level 1 oplock break, the system treats this control code as a complete acknowledgment of the break, and the caller is not required to close the file handle.

This control code is rarely used. When a client application is notified of an oplock break for a file, and it closes its handle for the file, the system treats the file handle close as a complete acknowledgment of the oplock break. Thus it is never necessary to send this control code.

To process this control code, a minifilter calls FltOplockFsctrl with the following parameters. A file system or legacy filter driver calls FsRtlOplockFsctrl.

For more information about opportunistic locking and about the FSCTL_OPBATCH_ACK_CLOSE_PENDING control code, see the Microsoft Windows SDK documentation.

Parameters

  • Oplock: Opaque oplock object pointer for the file.

  • CallbackData: FltOplockFsctrl only. Callback data (FLT_CALLBACK_DATA) structure for an IRP_MJ_FILE_SYSTEM_CONTROL FSCTL request. The FsControlCode parameter for the operation must be FSCTL_OPBATCH_ACK_CLOSE_PENDING.

  • Irp: FsRtlOplockFsctrl only. IRP for an IRP_MJ_FILE_SYSTEM_CONTROL FSCTL request. The FsControlCode parameter for the operation must be FSCTL_OPBATCH_ACK_CLOSE_PENDING.

  • OpenCount: Not used with this operation; set to zero.

Status block

FltOplockFsctrl always returns FLT_PREOP_COMPLETE for this operation.

FsRtlOplockFsctrl returns one of the following NTSTATUS values for this operation:

Code Meaning
STATUS_SUCCESS The oplock held by this handle was in the process of being broken.
STATUS_INVALID_OPLOCK_PROTOCOL No oplock was held by this handle, or the oplock break is not currently in progress. This is an error code.

Requirements

Requirement type Requirement
Header Ntifs.h (include Ntifs.h or Fltkernel.h)

See also

FLT_CALLBACK_DATA

FLT_PARAMETERS for IRP_MJ_FILE_SYSTEM_CONTROL

FltOplockFsctrl

FSCTL_OPLOCK_BREAK_ACK_NO_2

FSCTL_OPLOCK_BREAK_ACKNOWLEDGE

FSCTL_OPLOCK_BREAK_NOTIFY

FSCTL_REQUEST_BATCH_OPLOCK

FSCTL_REQUEST_FILTER_OPLOCK

FSCTL_REQUEST_OPLOCK_LEVEL_1

FSCTL_REQUEST_OPLOCK_LEVEL_2

FsRtlOplockFsctrl

IRP_MJ_FILE_SYSTEM_CONTROL