FSCTL_TXFS_MODIFY_RM 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.]

Sets the log mode and log parameter information for a secondary resource manager (RM).

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


BOOL
DeviceIoControl((HANDLE) hDevice,             // handle to device
                FSCTL_TXFS_MODIFY_RM,         // dwIoControlCode
                (LPVOID) lpInBuffer,          // input buffer
                (DWORD) nInBufferSize,        // size of input buffer
                NULL,                         // lpOutBuffer
                0,                            // nOutBufferSize
                (LPDWORD) lpBytesReturned,    // bytes returned
                (LPOVERLAPPED) lpOverlapped); // OVERLAPPED structure

Parameters

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

hDevice

A handle to the directory that is the root of the directory tree for the secondary RM.

dwIoControlCode

The control code for the operation. Use the FSCTL_TXFS_MODIFY_RM control code for this operation.

lpInBuffer

A pointer to the input buffer, a TXFS_MODIFY_RM structure.

nInBufferSize

The size of the input buffer, in bytes.

lpOutBuffer [optional]

Not used with this operation; set to NULL.

nOutBufferSize [optional]

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

lpBytesReturned

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.

lpOverlapped [optional]

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.

Return value

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

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

Remarks

FSCTL_TXFS_MODIFY_RM is a synchronous operation.

This control code is for remote clients to use when setting log parameters, and for local clients to specify log parameters for the default RMs.

Note  You cannot set the logging mode for a default RM. The logging mode for a default RM is TXFS_LOGGING_MODE_SIMPLE.

ReFS:  This code is not supported.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

WinIoCtl.h (include Windows.h)

See also

DeviceIoControl
Secondary Resource Managers for TxF Volumes
TXFS_MODIFY_RM

 

 

Community Additions

ADD
Show:
© 2014 Microsoft