INapSystemHealthValidationRequest::GetSoHRequest method

Note

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

The INapSystemHealthValidationRequest::GetSoHRequest method allows System Health Validators (SHVs) to retrieve and validate the SoHRequest information sent by their System Health Agent (SHA) counterparts on the client.

Syntax

HRESULT GetSoHRequest(
  [out] SoHRequest **sohRequest,
  [out] BOOL       *napSystemGenerated
);

Parameters

sohRequest [out]

A pointer to a pointer to an SoHRequest structure.

napSystemGenerated [out]

A BOOL that is TRUE if the SoH was created by the NapAgent on behalf of the SHA and FALSE otherwise. It is primarily used to indicate an SHA failure to the SHV.

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.

Remarks

The sohRequest parameter may return NULL if the client did not send an SoHRequest to the SHV. In that scenario the SHV can populate an SoHResponse with the error code of NAP_E_MISSING_SOH.

If the napSystemGenerated parameter is TRUE, the format of SoHRequest is as follows:

• sohAttributeTypeSystemHealthId= <id>
• sohAttributeTypeFailureCategory= failureCategoryClientComponent
• sohAttributeTypeErrorCodes = <sha-failure-error-code>

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2008 [desktop apps only]
Header	NapSystemHealthValidator.h
IDL	NapSystemHealthValidator.idl
DLL	Qshvhost.dll

See also

INapSystemHealthValidationRequest