NotifyAddrChange
A version of this page is also available for
4/8/2010
This function causes a notification to be sent to the caller whenever a change occurs in the table that maps IP addresses to interfaces.
Syntax
DWORD NotifyAddrChange(
PHANDLE Handle,
LPOVERLAPPED overlapped
);
Parameters
- Handle
[in] Pointer to a handle to use in asynchronous notification. The application should close this handle by calling the CloseHandle function when it is finished listening for events.
- overlapped
[in] Not supported in Windows Embedded CE.
Return Value
Returns NO_ERROR if successful. If the function fails, it returns an error code. For a complete list of error codes, see Error Values or the SDK header file Winerror.h.
Remarks
If the application specifies NULL for the Handle parameter, the call to this function blocks until an IP address change occurs. The application must call CloseHandle on the retrieved handle when it is no longer needed.
The returned event is pulsed, not set, thus the application has to call WaitForSingleObject after it calls NotifyAddrChange in order to be waiting when the address changes. The application cannot wait for this event and expect it to be in set state after the address changed.
Requirements
Header | iphlpapi.h |
Library | Iphlpapi.lib |
Windows Embedded CE | Windows CE 3.0 and later |
Windows Mobile | Windows Mobile Version 5.0 and later |