Export (0) Print
Expand All

FSCTL_GET_INTEGRITY_INFORMATION control code

Retrieves the integrity status of a file or directory on a ReFS volume.

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


BOOL 
WINAPI 
DeviceIoControl( (HANDLE) hDevice,                // handle to file or directory
                 FSCTL_GET_INTEGRITY_INFORMATION, // dwIoControlCode
                 (LPDWORD) NULL,                  // pInBuffer 
                 (DWORD) 0,                       // InBufferSize 
                 (LPDWORD) pOutBuffer,            // FSCTL_GET_INTEGRITY_INFORMATION_BUFFER
                 (DWORD) OutBufferSize,           // size of output buffer
                 (LPDWORD) lpBytesReturned,       // number of bytes returned
                 (LPOVERLAPPED) lpOverlapped );   // OVERLAPPED structure

Parameters

hDevice [in]

A handle to the file or directory. To obtain a handle, call the CreateFile function.

dwIoControlCode [in]

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

lpInBuffer

Not used with this operation; set to NULL.

nInBufferSize [in]

Not used with this operation; set to 0.

lpOutBuffer [out]

Address of a FSCTL_GET_INTEGRITY_INFORMATION_BUFFER structure.

nOutBufferSize [in]

The size of the input buffer, in bytes. Must be at least sizeof(FSCTL_GET_INTEGRITY_INFORMATION_BUFFER).

lpBytesReturned [out]

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

If the output buffer is too small, the call fails, GetLastError returns ERROR_INSUFFICIENT_BUFFER, and lpBytesReturned is zero.

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 the hDevice parameter is associated with an I/O completion port, you can retrieve the number of bytes returned by calling GetQueuedCompletionStatus.

lpOverlapped [in]

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. To get extended error information, call GetLastError.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

WinIoCtl.h (include Windows.h)

See also

Volume Management Control Codes
DeviceIoControl
FSCTL_GET_INTEGRITY_INFORMATION_BUFFER
FSCTL_SET_INTEGRITY_INFORMATION

 

 

Community Additions

ADD
Show:
© 2015 Microsoft