FSCTL_OPBATCH_ACK_CLOSE_PENDING control code

Notifies a server that a client application is ready to close a file. Use this operation after notification that an opportunistic lock on a file is ready to be broken.

To perform this operation, call the DeviceIoControl function by using the following parameters.



BOOL DeviceIoControl(
  (HANDLE) hDevice,                // handle to file
  FSCTL_OPBATCH_ACK_CLOSE_PENDING, // dwIoControlCode
  NULL,                            // lpInBuffer
  0,                               // nInBufferSize
  NULL,                            // lpOutBuffer
  0,                               // nOutBufferSize
  (LPDWORD) lpBytesReturned,       // number of bytes returned
  (LPOVERLAPPED) lpOverlapped      // OVERLAPPED structure
);

Parameters

hDevice

A handle to the file or alternate stream about which a request is made.

To retrieve a file handle, call the CreateFile function. The file or alternate stream must be opened with the FILE_FLAG_OVERLAPPED flag. This file handle must be the same one for which the original opportunistic lock is requested.

dwIoControlCode

The control code for the operation.

Use FSCTL_OPBATCH_ACK_CLOSE_PENDING for the operation.

lpInBuffer

Not used with this operation; set to NULL.

nInBufferSize

Not used with this operation; set to 0 (zero).

lpOutBuffer

Not used with this operation; set to NULL.

nOutBufferSize

Not used with this operation; set to 0 (zero).

lpBytesReturned

A pointer to a variable that receives the size of the data stored in the output buffer, in bytes.

This parameter is meaningless until the overlapped operation has completed. To retrieve the number of bytes returned, call GetOverlappedResult. If hDevice is associated with an I/O completion port, you can retrieve the number of bytes returned by calling GetQueuedCompletionStatus.

lpOverlapped

A pointer to an OVERLAPPED structure.

Because hDevice is opened with the FILE_FLAG_OVERLAPPED flag, the operation is performed as an overlapped (asynchronous) operation. Therefore, lpOverlapped must point to a valid OVERLAPPED structure that contains a handle to an event object. Otherwise, the function fails in unpredictable ways.

DeviceIoControl returns immediately, and the event object is signaled when the operation is complete.

Return value

If the operation completes successfully, DeviceIoControl returns a nonzero value.

If the operation fails or is pending, DeviceIoControl returns 0 (zero). To get extended error information, call GetLastError.

Remarks

Before you call this function do not make assumptions about the number of available virtual channels, because the system and other plug-ins might have reserved virtual channels. Always check for a CHANNEL_RC_TOO_MANY_CHANNELS return code after calling this function.

For the implications of overlapped I/O on this operation, see the Remarks section of the DeviceIoControl topic.

Use the FSCTL_OPBATCH_ACK_CLOSE_PENDING control code when you are notified that an opportunistic lock on a file is ready to be broken, and you intend to close the file soon. This operation does not request a new opportunistic lock.

If you do not intend to close a file, you can use the FSCTL_OPLOCK_BREAK_ACKNOWLEDGE or FSCTL_OPLOCK_BREAK_ACK_NO_2 control code to respond to the notification. The former, used if the lock being broken is an exclusive opportunistic lock, indicates the file should receive a level 2 opportunistic lock instead. The latter requests the file be kept open but loses all locking.

Applications are notified that an opportunistic lock is broken by using the hEvent member of the OVERLAPPED structure that is associated with a file on which an opportunistic lock is broken. Applications can also use functions such as GetOverlappedResult and HasOverlappedIoCompleted.

IIn Windows 8 and Windows Server 2012, this code is supported by the following technologies.

TechnologySupported

Server Message Block (SMB) 3.0 protocol

No

SMB 3.0 Transparent Failover (TFO)

No

SMB 3.0 with Scale-out File Shares (SO)

No

Cluster Shared Volume File System (CsvFS)

Yes

Resilient File System (ReFS)

Yes

 

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

WinIoCtl.h (include Windows.h)

See also

CreateFile
DeviceIoControl
FSCTL_OPLOCK_BREAK_ACK_NO_2
FSCTL_OPLOCK_BREAK_ACKNOWLEDGE
GetOverlappedResult
HasOverlappedIoCompleted
Opportunistic Locks
OVERLAPPED

 

 

Show: