INapEnforcementClientConnection::GetCorrelationId method

Note

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

The INapEnforcementClientConnection::GetCorrelationId method gets the ID used to correlate SoH-requests and SoH-responses.

Syntax

HRESULT GetCorrelationId(
  [out] CorrelationId *correlationId
);

Parameters

correlationId [out]

A unique CorrelationId structure that identifies this SoH exchange.

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 correlation-id is set by the NapAgent and based on the connection-id.

This id is used to correlate requests and responses, i.e. it uniquely describes an SoH exchange and always contains the id of the most recent SoH set on the connection object.

When an SoH-Response is received, the NapAgent first ensures the IDs match; if not, an error is returned and the enforcer must drop the packet. See INapEnforcementClientBinding::ProcessSoHResponse for more details.

Requirements

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

See also

INapEnforcementClientConnection