FSCTL_TXFS_CREATE_MINIVERSION control code
[Microsoft strongly recommends developers utilize alternative means to achieve your application’s needs. Many scenarios that TxF was developed for can be achieved through simpler and more readily available techniques. Furthermore, TxF may not be available in future versions of Microsoft Windows. For more information, and alternatives to TxF, please see Alternatives to using Transactional NTFS.]
Creates a new miniversion for the specified file.
Miniversions allow you to refer to a snapshot of the file during a transaction. Miniversions are discarded when a transaction is committed or rolled back.
BOOL DeviceIoControl( (HANDLE) hDevice, // handle to device FSCTL_TXFS_CREATE_MINIVERSION, // dwIoControlCode NULL, // lpInBuffer 0, // nInBufferSize (LPVOID) lpOutBuffer, // output buffer (DWORD) nOutBufferSize, // size of output buffer (LPDWORD) lpBytesReturned, // number of bytes returned (LPOVERLAPPED) lpOverlapped // OVERLAPPED structure );
To perform this operation, call the DeviceIoControl function with the following parameters.
A handle to the file to create the miniversion of.
The control code for the operation. Use FSCTL_TXFS_CREATE_MINIVERSION for this operation.
Not used with this operation; set to NULL.
Not used with this operation; set to 0 (zero).
A pointer to the output buffer, a TXFS_CREATE_MINIVERSION_INFO structure.
The size of the output buffer, in bytes.
A pointer to a variable that receives the size of the data stored in the output buffer, in bytes.
If lpOverlapped is NULL, lpBytesReturned cannot be NULL. Even when an operation returns no output data and lpOutBuffer is NULL, DeviceIoControl makes use of lpBytesReturned. After such an operation, the value of lpBytesReturned is meaningless.
If lpOverlapped is not NULL, lpBytesReturned can be NULL. If this parameter is not NULL and the operation returns data, lpBytesReturned 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.
A pointer to an OVERLAPPED structure.
If hDevice was opened without specifying FILE_FLAG_OVERLAPPED, lpOverlapped is ignored.
If hDevice was opened with the FILE_FLAG_OVERLAPPED flag, the operation is performed as an overlapped (asynchronous) operation. In this case, lpOverlapped must point to a valid OVERLAPPED structure that contains a handle to an event object. Otherwise, the function fails in unpredictable ways.
For overlapped operations, DeviceIoControl returns immediately, and the event object is signaled when the operation has been completed. Otherwise, the function does not return until the operation has been completed or an error occurs.
If the operation completes successfully, DeviceIoControl returns a nonzero value.
FSCTL_TXFS_CREATE_MINIVERSION is a synchronous operation.
If you attempt to create a miniversion in a non-active transaction, ERROR_INVALID_TRANSACTION is returned.
ReFS: This code is not supported.
Minimum supported client
|Windows Vista [desktop apps only]|
Minimum supported server
|Windows Server 2008 [desktop apps only]|
Build date: 4/16/2013