Edit

Share via

IStreamAsync::OverlappedResult method (shobjidl.h)

  • Article

Retrieves the results of an overlapped operation.

Syntax

HRESULT OverlappedResult(
  [in]  LPOVERLAPPED lpOverlapped,
  [out] LPDWORD      lpNumberOfBytesTransferred,
  [in]  BOOL         bWait
);

Parameters

[in] lpOverlapped

Type: LPOVERLAPPED*

A pointer to the OVERLAPPED structure that was specified when the overlapped operation was started.

[out] lpNumberOfBytesTransferred

Type: LPDWORD

When this method returns, contains the number of bytes that were actually transferred by a read or write operation.

[in] bWait

Type: BOOL

If TRUE the method does not return until the operation has been completed. If FALSE and an operation is pending, the method returns the HRESULT equivalent to ERROR_IO_INCOMPLETE.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header shobjidl.h