OverlappedResult
Collapse the table of content
Expand the table of content

IStreamAsync::OverlappedResult method

Retrieves the results of an overlapped operation.

Syntax


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

Parameters

lpOverlapped [in]

Type: LPOVERLAPPED*

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

lpNumberOfBytesTransferred [out]

Type: LPDWORD

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

bWait [in]

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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Shobjidl.h

IDL

Shobjidl.idl

 

 

Show:
© 2016 Microsoft