Share via

IOCTL_FLASH_FORMAT_STORE (Compact 2013)

  • Article

3/26/2014

This I/O control message queries erases all of the blocks in the flash region and reinitializes the partition table. Send this message with DeviceIoControl.

Syntax

BOOL DeviceIoControl(
    HANDLE hDevice,           // handle to the device
    DWORD dwIoControlCode,    // use IOCTL_FLASH_FORMAT_STORE
    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
    [in] Handle to the device.
  • dwIoControlCode
    [in] The control code for the operation. Use IOCTL_FLASH_FORMAT_STORE for this operation.
  • lpInBuffer
    [in] Pointer to a DWORD containing the region index to format. Alternatively, pass NULL to format all regions.
  • nInBufferSize
    [in] Size of a DWORD when formatting a single region. Set to zero (0) when formatting the entire store.
  • lpOutBuffer
    [in] Not used; set to NULL.
  • nOutBufferSize
    [out] Not used; set to zero.
  • lpBytesReturned
    [in] Not used; set to NULL.

Return Values

Returns nonzero if successful; otherwise, returns zero.

Remarks

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

Requirements

Header

FlashMdd.h

See Also

Reference

Flash Driver MDD IOCTLs