INDOverlapped::GetOverlappedResult Method

Article
2010-07-02

Retrieves the result of an overlapped request.

Syntax

HRESULT GetOverlappedResult(
  [in]   OVERLAPPED *pOverlapped,
  [out]  SIZE_T *pNumberOfBytesTransferred,
  [in]   BOOL bWait
);

Parameters

pOverlapped [in]
The OVERLAPPED structure that was specified when the overlapped operation was started.
pNumberOfBytesTransferred [out]
The number of bytes transferred as part of the request. For requests without output parameters, this value is provider implementation specific and does not convey any meaning to the client.
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 ND_PENDING.

Return Value

When you implement this method, you should return the following return values. If you return others, try to use well-known values to aid in debugging issues.

Return code	Description
ND_SUCCESS	The operation completed successfully.
ND_PENDING	The operation is still outstanding and has not yet completed.
ND_CANCELED	The Network Direct adapter was closed, or a new request for asynchronous notification was requested.
ND_DEVICE_REMOVED	The underlying Network Direct adapter was removed from the system. Only cleanup operations on the Network Direct adapter will succeed.

Remarks

The behavior of this method is identical to that of the Win32 GetOverlappedResult function. You can call the GetOverlappedResult function, however, you will not get the Network Direct return value.

Requirements

Product	Microsoft Message Passing Interface (MS-MPI)
Header	Ndspi.h

Share via