MpThreatEnumerate function

Returns information about the next threat in the enumeration list. This function can be called repeatedly until the enumeration of all the threats is complete.

Syntax

HRESULT WINAPI MpThreatEnumerate(
  _In_  MPHANDLE       hThreatEnumHandle,
  _Out_ PMPTHREAT_INFO *ppThreatInfo
);

Parameters

hThreatEnumHandle [in]

Type: MPHANDLE

Handle to a threat enumeration context returned by MpThreatOpen.

ppThreatInfo [out]

Type: PMPTHREAT_INFO*

Returns a pointer to a threat information structure, MPTHREAT_INFO. The structure contains information such as threat id, name, and severity.

Return value

Type: HRESULT

If the function succeeds the return value is S_OK.

If there are no more items to return the return value is S_FALSE.

If the function fails then the return value is a failed HRESULT code. The caller can use the MpErrorMessageFormat function to get a generic description of the error message.

Requirements

See also

MpErrorMessageFormat

MpThreatOpen

MPTHREAT_INFO