MpUpdateControl function

Allows the control of a signature update operation that was asynchronously initiated via MpUpdateStart. Calling this function requires administrator privilege as it allows the cancellation of a system-wide signature update.

Syntax

HRESULT WINAPI MpUpdateControl(
  _In_ MPHANDLE  hUpdateHandle,
  _In_ MPCONTROL UpdateControl
);

Parameters

hUpdateHandle [in]

Type: MPHANDLE

Handle to an asynchronous signature update operation. This handle is returned by the MpScanStart function.

UpdateControl [in]

Type: MPCONTROL

Specifies the signature update control option. It must be the following value:

Value	Meaning
MPCONTROL_ABORT	Abort the signature update 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

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

MpScanStart