MpManagerStatusQueryEx function

Returns status information about various components of the malware protection manager.

Syntax

HRESULT WINAPI MpManagerStatusQueryEx(
  _In_  MPHANDLE       hMpHandle,
  _In_  DWORD          dwFlag,
  _Out_ PMPSTATUS_INFO pStatusInfo
);

Parameters

hMpHandle [in]

Type: MPHANDLE

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

dwFlag [in]

Type: DWORD

Controls which query information is returned. Some information is expensive and may not be needed.

Value	Meaning
MP_STATUS_QUERY_FLAGS_NONE	Default.
MP_STATUS_QUERY_FLAG_NOSTATE	Do not query for state information.

pStatusInfo [out]

Type: PMPSTATUS_INFO

Pointer to a structure that returns status information regarding last scans, active threats and various component status. See MPSTATUS_INFO.

Return value

Type: HRESULT

If the function succeeds the return value is S_OK. This function call is guaranteed to succeed even if an AntiMalware service is not running.

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

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Header	MpClient.h
DLL	MpClient.dll

See also

MpErrorMessageFormat

MpManagerOpen

MPSTATUS_INFO