Platform SDK: Hardware |
The FSCTL_OPBATCH_ACK_CLOSE_PENDING operation notifies a server that a client application is about to close a file. An application uses this operation following notification that an opportunistic lock on the file is about to be broken.
To perform this operation, call the DeviceIoControl function using the following parameters.
BOOL DeviceIoControl( (HANDLE) hDevice, // handle to file FSCTL_OPBATCH_ACK_CLOSE_PENDING, // dwIoControlCode operation NULL, // lpInBuffer; must be NULL 0, // nInBufferSize; must be zero NULL, // lpOutBuffer; must be NULL 0, // nOutBufferSize; must be zero (LPDWORD) lpBytesReturned, // number of bytes returned (LPOVERLAPPED) lpOverlapped // OVERLAPPED structure );
If lpOverlapped is NULL (nonoverlapped I/O), lpBytesReturned is used internally and cannot be NULL.
If lpOverlapped is not NULL (overlapped I/O), lpBytesReturned can be NULL.
If hDevice was opened with the FILE_FLAG_OVERLAPPED flag, lpOverlapped must point to a valid OVERLAPPED structure. In this case, DeviceIoControl is performed as an overlapped (asynchronous) operation. If the device was opened with the FILE_FLAG_OVERLAPPED flag and lpOverlapped is NULL, the function fails in unpredictable ways.
If hDevice was opened without specifying the FILE_FLAG_OVERLAPPED flag, lpOverlapped is ignored and the DeviceIoControl function does not return until the operation has been completed, or until an error occurs.
If the operation succeeds, DeviceIoControl returns a nonzero value.
If the operation fails, DeviceIoControl returns zero. To get extended error information, call GetLastError.
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 operation when you have been notified that an opportunistic lock on a file is about to be broken, and you intend to close the file shortly. This operation does not request a new opportunistic lock.
If you do not intend to close the file, you can use either the FSCTL_OPLOCK_BREAK_ACKNOWLEDGE or FSCTL_OPLOCK_BREAK_ACK_NO_2 operation to respond to this 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 looses all locking.
Applications are notified that an opportunistic lock is broken by using the hEvent member of the OVERLAPPED structure associated with the file on which the opportunistic lock is broken. Applications may also use functions such as GetOverlappedResult and HasOverlappedIoCompleted.
Windows NT/2000: Requires Windows 2000.
Windows 95/98: Unsupported.
Header: Declared in Winioctl.h.
Device Input and Output Overview, Device Input and Output Control Codes, CreateFile, DeviceIoControl, FSCTL_OPLOCK_BREAK_ACK_NO_2, FSCTL_OPLOCK_BREAK_ACKNOWLEDGE, GetOverlappedResult, HasOverlappedIoCompleted, Opportunistic Locks, OVERLAPPED