IOCTL_DISK_GET_CLUSTER_INFO control code

Retrieves the attributes of the specified disk device.

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

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

Parameters

hDevice

A handle to the disk.

To retrieve a device handle, call the CreateFile function.

dwIoControlCode

The control code for the operation.

Use IOCTL_DISK_GET_CLUSTER_INFO for this operation.

lpInBuffer

Not used with this operation. Set to NULL.

nInBufferSize

The size of the input buffer, in bytes. Set to 0 (zero).

lpOutBuffer

A pointer to a buffer that receives a DISK_CLUSTER_INFO data structure.

nOutBufferSize

The size of the output buffer, in bytes.

lpBytesReturned

Not used with this operation. Set to NULL.

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, indicating that all volumes on the disk are ready for use, DeviceIoControl returns a nonzero value.

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

Requirements

See also

DeviceIoControl

Disk Management Control Codes

DISK_CLUSTER_INFO

IOCTL_DISK_SET_CLUSTER_INFO