FSCTL_QUERY_USN_JOURNAL - NtDoc

Native API online documentation, based on the System Informer (formerly Process Hacker) phnt headers
// ntifs.h

// CTL_CODE(0x0009, 0x03d, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define FSCTL_QUERY_USN_JOURNAL 0x000900F4
View the official Windows Driver Kit DDI reference
// winioctl.h

// CTL_CODE(0x0009, 0x03d, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define FSCTL_QUERY_USN_JOURNAL 0x000900F4
View the official Win32 API reference

NtDoc

No description available.

Windows Driver Kit DDI reference (ni-ntifs-fsctl_query_usn_journal)

Description

The FSCTL_QUERY_USN_JOURNAL control code queries for information on the current update sequence number (USN) change journal, its records, and its capacity. See Remarks.

Parameters

Major code

FSCTL_QUERY_USN_JOURNAL

Input buffer

Input buffer length

Output buffer

Output buffer length

Input/output buffer

Input/output buffer length

Status block

Remarks

To perform this operation, call FltFsControlFile or ZwFsControlFile with the following parameters.

FltFsControlFile or ZwFsControlFile returns STATUS_SUCCESS if the operation succeeds. Otherwise, the appropriate function returns the appropriate NTSTATUS error code.

See also

USN_JOURNAL_DATA_V0

USN_JOURNAL_DATA_V1

USN_JOURNAL_DATA_V2


Win32 API reference (ni-winioctl-fsctl_query_usn_journal)

FSCTL_QUERY_USN_JOURNAL IOCTL

Description

Queries for information on the current update sequence number (USN) change journal, its records, and its capacity.

C++
BOOL WINAPI DeviceIoControl( (HANDLE) Device, // handle to volume (DWORD) FSCTL_QUERY_USN_JOURNAL,// dwIoControlCode (LPVOID) NULL, // lpInBuffer (DWORD) 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 using the following parameters.

Parameters

Input buffer

Input buffer length

Output buffer

Output buffer length

Input/output buffer

Input/output buffer length

Status block

Irp->IoStatus.Status is set to STATUS_SUCCESS if the request is successful.

Otherwise, Status to the appropriate error condition as a NTSTATUS code.

For more information, see NTSTATUS Values.

Remarks

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

For more information, see Creating, Modifying, and Deleting a Change Journal.

To retrieve a handle to a volume, call CreateFile with the lpFileName parameter set to a string in the following form:

\.*X*:

In the preceding string, X is the letter identifying the drive on which the volume appears. The volume must be formatted with the NTFS filesystem.

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

Technology Supported
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

An application may experience false positives on CsvFs pause/resume.

See also

Change Journals

CreateFile

DeviceIoControl

GetOverlappedResult

GetQueuedCompletionStatus

OVERLAPPED

USN_JOURNAL_DATA_V0

USN_JOURNAL_DATA_V1

USN_JOURNAL_DATA_V2

Volume Management Control Codes