IOCTL_DISK_SET_DRIVE_LAYOUT_EX Control Code

Partitions a disk according to the specified drive layout and partition information data.

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

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

Parameters hDevice

The handle to the disk drive to be partitioned. To retrieve a device handle, call the function.

dwIoControlCode

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

lpInBuffer

A pointer to the drive layout information to be set. The information is contained in the structure.

nInBufferSize

The size of the buffer pointed to by lpOutBuffer, in bytes.

lpOutBuffer

Not used with this operation; set to NULL.

nOutBufferSize

Not used with this operation; set to zero.

lpBytesReturned

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

If lpOverlapped is NULL, lpBytesReturned cannot be NULL. Even when an operation does not return output data and lpOutBuffer is NULL, uses lpBytesReturned. After the 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 is complete. To retrieve the number of bytes returned, call . If hDevice is associated with an I/O completion port, you can retrieve the number of bytes returned by calling .

lpOverlapped

A pointer to an structure.

If hDevice is opened without specifying FILE_FLAG_OVERLAPPED, lpOverlapped is ignored.

If hDevice is opened by using the FILE_FLAG_OVERLAPPED flag, the operation is performed as an overlapped (asynchronous) operation. In this case, lpOverlapped must point to a valid structure that contains a handle to an event object. Otherwise, the function fails in unpredictable ways.

For overlapped operations, returns immediately, and the event object is signaled when the operation is complete. Otherwise, the function does not return until the operation is complete or an error occurs.

Return Value

If the operation completes successfully, returns a nonzero value.

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

Remarks

When specifying a GUID partition table (GPT) as the of the structure, an application should wait for the MSR partition arrival before sending the IOCTL_DISK_SET_DRIVE_LAYOUT_EX control code. For more information about device notification, see .

When creating and manipulating an Extended Boot Record (EBR), the first entry of the EBR should point to the logical drive that immediately follows the EBR and the next EBR should lie after the end of the current logical drive and before the start of the next logical drive. For more information, see .

If the partition is on a disk formatted as type master boot record (MBR), partition size totals are limited. For more information, see the Remarks section of .

Requirements

Minimum supported client	Windows XP
Minimum supported server	Windows Server 2003
Header	WinIoCtl.h