INapSystemHealthAgentBinding::NotifySoHChange method

Note

The Network Access Protection platform is not available starting with Windows 10

The INapSystemHealthAgentBinding::NotifySoHChange method is used by SHAs when their SoH changes.

Syntax

HRESULT NotifySoHChange();

Parameters

This method has no parameters.

Return value

Other COM-specific error codes also may be returned.

Return code Description
S_OK
Operation succeeded.
E_ACCESSDENIED
Permissions error, access denied.
E_OUTOFMEMORY
System resource limit, could not perform the operation.
NAP_E_NOT_INITIALIZED
The SHA has not been previously initialized.
RPC_E_DISCONNECTED
The NapAgent has been stopped. This object will recover automatically and rebind to the NapAgent, once it restarts.

Remarks

SHAs must not call this API speculatively since it results in an SoH exchange on the wire. Calls to this API should only be made when necessary.

The NapAgent does not hold this thread to process the SoH change. Instead, it returns immediately and processes the change asynchronously.

The SHA must call Initialize before calling this method or any other method of the INapSystemHealthAgentBinding2 interface.

Requirements

Requirement Value
Minimum supported client
Windows Vista [desktop apps only]
Minimum supported server
Windows Server 2008 [desktop apps only]
Header
NapSystemHealthAgent.h
IDL
NapSystemHealthAgent.idl
DLL
Qagent.dll

See also

INapSystemHealthAgentBinding