CancelSecurityHealthChangeNotify function

Article
03/20/2018

The CancelSecurityHealthChangeNotify function deregisters for change notifications to network security health on a local computer.

Syntax

BOOL WINAPI CancelSecurityHealthChangeNotify(
   LPOVERLAPPED notifyOverlapped
);

Parameters

notifyOverlapped
A pointer to an OVERLAPPED structure returned by the NotifySecurityHealthChange function.

Return value

If the function succeeds, the return value is TRUE.

If the function fails, the return value is FALSE. The specific error code can be returned by a call to GetLastError.

Return code	Description
ERROR_INVALID_PARAMETER	An invalid parameter was passed to the function.
Other	Use the FormatMessage function to obtain the message string for the returned error.

Remarks

The CancelSecurityHealthChangeNotify function is only supported on Windows Server 2003 with Service Pack 1 (SP1) and Windows Server 2003 with Service Pack 2 (SP2).

Note The CancelSecurityHealthChangeNotify function is not supported on Windows Vista and Windows Server 2008.

The CancelSecurityHealthChangeNotify function deregisters for an asynchronous change notification previously requested for network security health on a local computer. A request to register for change notification is made by calling NotifySecurityHealthChange function with the pHandle and pOverLapped parameters not NULL.

The pOverLapped parameter returned to the NotifySecurityHealthChange function is passed to CancelSecurityHealthChangeNotify in the notifyOverlapped parameter to deregister for change notification.

The CancelSecurityHealthChangeNotify function can only be used when the call to the NotifySecurityHealthChange function was made asynchronously (the pHandle and pOverLapped parameters passed to NotifySecurityHealthChange were not be NULL).

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2003 with SP1 [desktop apps only]
End of server support	Windows Server 2003 with SP2
Header	Iphlpapi.h
Library	Iphlpapi.lib
DLL	Iphlpapi.dll

Partager via