Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

IOCTL_STORAGE_SET_HOTPLUG_INFO control code

Sets the hotplug configuration of the specified device.

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



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

Parameters

hDevice

A handle to the object from which the media type is to be retrieved. To retrieve a device handle, call the CreateFile function.

dwIoControlCode

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

lpInBuffer

A pointer to a buffer containing the returned STORAGE_HOTPLUG_INFO data structure. This data structure contains the hotplug configuration of the specified device.

nInBufferSize

The size of the input buffer, 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 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. To get extended error information, call GetLastError.

Remarks

Refer to the Remarks section in the reference page for STORAGE_HOTPLUG_INFO for more information about hotplug devices.

This operation sets only the DeviceHotplug member of the STORAGE_HOTPLUG_INFO structure passed in.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

Header

WinIoCtl.h (include Windows.h)

See also

Device Management Control Codes
DeviceIoControl
IOCTL_STORAGE_GET_HOTPLUG_INFO
STORAGE_HOTPLUG_INFO

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.