Share via

IOCTL_DISK_SET_SECURE_WIPE_FLAG (Compact 2013)

  • Article

3/26/2014

This I/O control message sets a flag indicating a secure wipe is to be performed on the next reboot. The handle is a handle to the file system volume. Send this message with DeviceIoControl.

Syntax

BOOL DeviceIoControl(
    HANDLE hDevice,           // handle to device
    DWORD dwIoControlCode,    // use IOCTL_DISK_SET_SECURE_WIPE_FLAG
    LPVOID lpInBuffer,        // pointer to input buffer
    DWORD nInBufferSize,      // input buffer size
    LPVOID lpOutBuffer,       // pointer to output buffer
    DWORD nOutBufferSize,     // output buffer size
    LPDWORD lpBytesReturned,  // number of bytes returned
    OVERLAPPED lpOverlapped   // pointer to OVERLAPPED structure
);

Parameters

  • hDevice
    The handle to the device.
  • dwIoControlCode
    [in] Control code for the operation. Use IOCTL_DISK_SET_SECURE_WIPE_FLAG for this operation.
  • lpInBuffer
    [in] Not used; set to NULL.
  • nInBufferSize
    [in] Not used; set to zero.
  • lpOutBuffer
    [out] Not used; set to NULL.
  • nOutBufferSize
    [out] Not used; set to zero.
  • lpBytesReturned
    [out] Not used; set to NULL.
  • lpOverlapped
    Not used.

Return Values

Returns nonzero value if successful; otherwise, returns zero.

Remarks

To get extended error information, call GetLastError. GetLastError may return other standard error messages as appropriate.

Remarks

After the flag is set, the call returns. When the calling application reboots the system, the secure wipe is performed. After the reboot, ExFAT passes the FATUTIL_SECURE_WIPE flag to the FORMAT_OPTIONS structure.

The following example shows how to obtain a handle to the file system volume:

h = CreateFile ( "<MountPoint>\VOL:", ...)

Requirements

Header

diskio.h

See Also

Reference

Block Driver IOCTLs
DELETE_SECTOR_INFO

Other Resources

FORMAT_OPTIONS