MpThreatQuery function

Used to query static (such as severity and category) or localized (such as category description and advice) information about a particular threat.

Syntax

HRESULT WINAPI MpThreatQuery(
  _In_      MPHANDLE                 hMpHandle,
  _In_      MPTHREAT_ID              ThreatID,
  _Out_     PMPTHREAT_INFO           *ppThreatInfo,
  _Out_opt_ PMPTHREAT_LOCALIZED_INFO *ppThreatLocalizedInfo
);

Parameters

hMpHandle [in]

Type: MPHANDLE

Handle to the malware protection manager interface. This handle is returned by the MpManagerOpen function.

ThreatID [in]

Type: MPTHREAT_ID

Threat identifier for which information is requested.

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.

ppThreatLocalizedInfo [out, optional]

Type: PMPTHREAT_LOCALIZED_INFO*

Returns a pointer to a structure containing localized information about the threat. You can pass NULL if you are not interested in localized information about the threat. See MPTHREAT_LOCALIZED_INFO.

Return value

Type: HRESULT

If the function succeeds the return value is S_OK.

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

MpManagerOpen

MPTHREAT_INFO

MPTHREAT_LOCALIZED_INFO