IOCTL_VOLUME_GET_GPT_ATTRIBUTES control code

Retrieves the attributes for a volume.

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


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

Parameters

hDevice [in]

A handle to a volume. To obtain a volume handle, call the CreateFile function.

dwIoControlCode [in]

A control code for the operation. Use IOCTL_VOLUME_GET_GPT_ATTRIBUTES for this operation.

lpInBuffer

Not used with this operation. Set to NULL.

nInBufferSize [in]

Not used with this operation. Set to zero.

lpOutBuffer [out]

A pointer to a buffer that receives a VOLUME_GET_GPT_ATTRIBUTES_INFORMATION structure that specifies the attributes associated with the volume.

nOutBufferSize [in]

The size of the output buffer, in bytes.

lpBytesReturned [out]

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

If the output buffer is less than sizeof(VOLUME_GET_GPT_ATTRIBUTES_INFORMATION), the call fails, GetLastError returns ERROR_INVALID_PARAMETER, and lpBytesReturned is zero.

If lpOverlapped is NULL, lpBytesReturned cannot be NULL. Even when an operation does not return output data and lpOutBuffer is NULL, DeviceIoControl uses lpBytesReturned. After that kind of 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 GetOverlappedResult. If hDevice 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 is opened without specifying FILE_FLAG_OVERLAPPED, lpOverlapped is ignored.

If hDevice is 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 is complete. Otherwise, the function does not return until the operation is complete 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.

Remarks

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

TechnologySupported

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

 

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

WinIoCtl.h (include Windows.h)

See also

DeviceIoControl
VOLUME_GET_GPT_ATTRIBUTES_INFORMATION
Volume Management Control Codes

 

 

Community Additions

ADD
Show:
© 2014 Microsoft