MpScanControl function

Allows the control of a scan that was asynchronously initiated via MpScanStart.

Syntax

HRESULT WINAPI MpScanControl(
  _In_ MPHANDLE  hScanHandle,
  _In_ MPCONTROL ScanControl
);

Parameters

hScanHandle [in]

Type: MPHANDLE

Handle to an asynchronous scan operation. This handle is returned by the MpScanStart function. This parameter can also be set to the malware protection manager interface handle returned by MpManagerOpen function to control a system initiated scan, in which case the caller must have administrative privilege.

ScanControl [in]

Type: MPCONTROL

Specifies a scan control option. This parameter must be one of the following control options:

Value	Meaning
MPCONTROL_ABORT	Abort the scan operation.
MPCONTROL_PAUSE	Pause the scan operation.
MPCONTROL_RESUME	Resume the paused scan operation.

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

MpScanStart