IOCTL_STORAGE_MEDIA_REMOVAL control code
Enables or disables the mechanism that ejects media, for those devices possessing that locking capability.
To perform this operation, call the DeviceIoControl function with the following parameters.
BOOL DeviceIoControl( (HANDLE) hDevice, // handle to device IOCTL_STORAGE_MEDIA_REMOVAL, // 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 );
A handle to the object from which media is to be removed. To retrieve a device handle, call the CreateFile function.
The control code for the operation. Use IOCTL_STORAGE_MEDIA_REMOVAL for this operation.
A pointer to a buffer that contains a PREVENT_MEDIA_REMOVAL data structure.
A TRUE value for that structure's PreventMediaRemoval member specifies that media removal is prevented (the device is locked). A FALSE value specifies that media removal is allowed.
The size of the input buffer, in bytes.
Not used with this operation; set to NULL.
Not used with this operation; set to zero.
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.
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.
If the operation completes successfully, DeviceIoControl returns a nonzero value.
The IOCTL_STORAGE_MEDIA_REMOVAL control code is valid only for devices that support removable media.
Minimum supported client
Minimum supported server
|Windows Server 2003|
- Device Management Control Codes