FSCTL_IS_VOLUME_OWNED_BYCSVFS control code

Determines whether a volume is locked by CSVFS.

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


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

Parameters

hDevice

A handle to the volume. To retrieve a volume handle, call the CreateFile function. Only administrators can open volume handles.

dwIoControlCode

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

lpInBuffer

Not used with this operation; set to NULL.

nInBufferSize

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

lpOutBuffer

A pointer to a CSV_IS_OWNED_BY_CSVFS structure, which specifies whether the volume is owned by CSVFS.

nOutBufferSize

The size of the output buffer, in bytes.

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

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

If the volume is locked on behalf of CSVFS, the control code returns information that is sent to an NTFS volume. If the volume is locked (using FSCTL_LOCK_VOLUME) from a request that originates from CSVFS, then the CSV_IS_OWNED_BY_CSVFS structure's OwnedByCSVFS member has a value of TRUE.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

WinIoCtl.h (include Windows.h)

See also

CreateFile
CSV_IS_OWNED_BY_CSVFS
DeviceIoControl
Volume Management Control Codes

 

 

Community Additions

ADD
Show:
© 2014 Microsoft