INapSystemHealthAgentCallback::CompareSoHRequests method

Note

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

The INapSystemHealthAgentCallback::CompareSoHRequests method is used by the SHA to compare SoH requests.

Syntax

HRESULT CompareSoHRequests(
  [in]  const SoHRequest *lhs,
  [in]  const SoHRequest *rhs,
  [out]       BOOL       *isEqual
);

Parameters

lhs [in]

A pointer to the SoHRequest on the left of the comparison operation.

rhs [in]

A pointer to the SoHRequest on the right of the comparison operation.

isEqual [out]

A pointer to a BOOL that is TRUE if lhs and rhs are semantically equal, and FALSE otherwise.

Return value

This method can return one of these values.

Return code	Description
S_OK	Indicates success.
E_NOTIMPL	The method was not implemented by the SHA.

Remarks

This callback method is declared by the NAP system and is to be implemented by the SHA writer.

The SHA should compare the SoHs and return TRUE if the SoHs are semantically equal. The NapAgent uses this information to determine if an SoH exchange should be initiated due to change of state of the client machine.

If SHAs have put incremental IDs or time-stamps into their SoH, then SoHs may be semantically equal (i.e. they may convey the same health information), but they may be byte-wise unequal. SHAs should implement this function to check for semantic equality of SoHs.

If SHAs have not put any time-stamps or Ids into their SoHs, they may choose to not implement this function and return E_NOTIMPL. In this case, the NapAgent performs a byte-wise comparison on the SoHRequests.

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

See also

INapSystemHealthAgentCallback

SoH