Share via

GetOverlappedResult (Compact 2013)

  • Article

3/26/2014

This function retrieves the results of an overlapped operation on the specified file, named pipe, or communications device.

Syntax

BOOL GetOverlappedResult(
   HANDLE hFile,
   LPOVERLAPPED lpOverlapped,
   LPDWORD lpNumberOfBytesTransferred,
   BOOL bWait
);

Parameters

  • hFile
    [in] A handle to the file, named pipe, or communications device.
  • lpOverlapped
    [in] A pointer to an OVERLAPPED structure that was specified when the overlapped operation was started.
  • lpNumberOfBytesTransferred
    [out] A pointer to a variable that receives the number of bytes that were actually transferred by a read or write operation.
  • bWait
    [in] If this parameter is TRUE, the function does not return until the operation has been completed. If this parameter is FALSE and the operation is still pending, the function returns FALSE and the GetLastError function returns ERROR_IO_INCOMPLETE.

Return Value

If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError

Requirements

Header

winbase.h

See Also

Reference

Device Manager Functions