GetAddrInfoExOverlappedResult function (ws2tcpip.h)

The GetAddrInfoExOverlappedResult function gets the return code for an OVERLAPPED structure used by an asynchronous operation for the GetAddrInfoEx function.

Syntax

INT WSAAPI GetAddrInfoExOverlappedResult(
  LPOVERLAPPED lpOverlapped
);

Parameters

lpOverlapped

A pointer to an OVERLAPPED structure for the asynchronous operation.

Return value

On success, the GetAddrInfoExOverlappedResult function returns NO_ERROR (0). When the underlying operation hasn't yet completed, the GetAddrInfoExOverlappedResult function returns WSAEINPROGRESS. On failure, the GetAddrInfoExOverlappedResult function returns WSAEINVAL.

Remarks

The GetAddrInfoExOverlappedResult function is used with the GetAddrInfoEx function for asynchronous operations.

If the GetAddrInfoExOverlappedResult function returns WSAEINVAL, the only way to distinguish whether GetAddrInfoExOverlappedResult function or the asynchronous operation returned the error is to check that the lpOverlapped parameter was not NULL. If the lpOverlapped parameter was NULL, then the GetAddrInfoExOverlappedResult function was passed a NULL pointer and failed.

Windows 8.1 and Windows Server 2012 R2: This function is supported for Windows Store apps on Windows 8.1, Windows Server 2012 R2, and later.

Requirements

   
Minimum supported client Windows 8.1, Windows 8 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 [desktop apps | UWP apps]
Target Platform Windows
Header ws2tcpip.h
Library Ws2_32.lib
DLL Ws2_32.dll

See also

GetAddrInfoEx