Share via

FSCTL_COPY_EXTERNAL_START (Compact 2013)

  • Article

3/26/2014

This I/O control message is called by a user application to copy from or to an external device. Send this message with DeviceIoControl.

Syntax

BOOL DeviceIoControl(
    HANDLE hDevice,           // handle to device
    DWORD dwIoControlCode,    // use FSCTL_COPY_EXTERNAL_START
    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, obtained from the CreateFile function.
  • dwIoControlCode
    [in] Control code for the operation. Use FSCTL_COPY_EXTERNAL_START for this operation.
  • nInBufferSize
    [in] Size of the input buffer.
  • lpOutBuffer
    [out] Not used; set to NULL.
  • nOutBufferSize
    [out] Not used; set to zero.
  • lpBytesReturned
    [out] Not used; set to NULL.
  • lpOverlapped
    Ignored.

Return Values

Returns nonzero value if successful; otherwise, returns zero.

Remarks

The caller of FSCTL_COPY_EXTERNAL should use a mapped pointer for pUserData in the FILE_COPY_EXTERNAL structure. The caller of this I/O control should also set cbSectorListSize to zero.

Requirements

Header

fsioctl.h

See Also

Reference

Copy External I/O Controls
CreateFile
FILE_COPY_EXTERNAL