MpScanStart 函数

启动扫描操作。

语法

HRESULT WINAPI MpScanStart(
  _In_     MPHANDLE          hMpHandle,
  _In_     MPSCAN_TYPE       ScanType,
  _In_     DWORD             dwScanOptions,
  _In_opt_ PMPSCAN_RESOURCES pScanResources,
  _In_opt_ PMPCALLBACK_INFO  pCallbackInfo,
  _Out_    PMPHANDLE         phScanHandle
);

parameters

hMpHandle [in]

类型: MPHANDLE

恶意软件防护管理器接口的句柄。 此句柄由 MpManagerOpen 函数返回。

ScanType [in]

类型: MPSCAN_TYPE

指定扫描的类型。 此参数必须是 MPSCAN_TYPE 获取的成员之一。

dwScanOptions [in]

类型:DWORD

指定用于扫描操作的各种选项。

含义
MPSCAN_OPTION_NONE
未请求任何特定选项。
MPSCAN_OPTION_ASYNC
扫描操作是异步的,其中 MpScanStart 在扫描成功启动后立即返回。 (默认情况下,扫描操作是同步的,这意味着 MpScanStart 仅在扫描完成后才会返回。)
MPSCAN_OPTION_PROGRESS
调用方希望通过回调接收扫描进度信息。
MPSCAN_OPTION_LOWPRIORITY
以低优先级执行扫描。 (默认情况下,扫描操作以正常的 priority 执行。)
MPSCAN_OPTION_PACKEDEXES
扫描打包的可执行文件中可能存在的威胁。
MPSCAN_OPTION_ARCHIVES
扫描存档内容中可能存在的威胁。 存档是扩展名为 .zip、.cab 或 .tar 的文件。
MPSCAN_OPTION_HEURISTICS
启用基于启发式扫描。 这将扫描检测类型设置为启发式的威胁。
MPSCAN_OPTION_REPORTFRIENDLY
报告资源扫描中的友好项。 这仅供内部使用。
MPSCAN_OPTION_REPORTUNKNOWN
报告资源扫描中的未知项。 这仅供内部使用。
MPSCAN_OPTION_NOCONSOLIDATE
不要将扫描结果与全局威胁视图合并。 这对于客户端 ((如电子邮件客户端) )非常有用,该客户端希望自行控制清理 UX,而不是允许默认的反恶意软件清理 UX。 这仅供内部使用。

pScanResources [in, optional]

类型: PMPSCAN_RESOURCES

指向扫描资源信息的指针。 对于快速扫描,此参数必须为 NULL 。 这是完全扫描的可选参数。 对于资源扫描,必须使用至少一个资源信息结构指定此参数。 若要扫描特定资源,调用方必须具有 资源GENERIC_READ 权限。 请参阅 MPSCAN_RESOURCES

pCallbackInfo [in, optional]

类型: PMPCALLBACK_INFO

指向回调信息的指针,用于向客户端提供扫描状态更改 (,例如开始和完成) 和进度信息。 在回调函数中传递回 MPCALLBACK_DATA 报告实际扫描状态和进度相关信息。 下面是可能的回调列表:

含义
MPNOTIFY_SCAN_START
扫描操作已开始。
MPNOTIFY_SCAN_COMPLETE
扫描操作已完成。 可通过 MPSCAN_DATA 结构获取其他信息。
MPNOTIFY_SCAN_PAUSED
扫描操作已暂停。
MPNOTIFY_SCAN_RESUMED
扫描操作已从暂停恢复。
MPNOTIFY_SCAN_CANCEL
扫描操作已取消。
MPNOTIFY_SCAN_PROGRESS
扫描进度信息。 可通过 MPSCAN_DATA 结构获取其他信息 (,例如资源统计信息 )
MPNOTIFY_SCAN_ERROR
扫描特定资源的错误信息。 特定资源信息可通过 MPSCAN_DATA 结构获得。
MPNOTIFY_SCAN_INFECTED
扫描发现受感染的资源。 请注意,在大多数情况下,这将导致在扫描结束时报告某些威胁。 有时,由于排除,它可能不会具体化为威胁。 可通过 MPSCAN_DATA 结构获取其他受感染的资源信息。
MPNOTIFY_SCAN_MEMORYSTART
已启动完全扫描的快速扫描部分。
MPNOTIFY_SCAN_MEMORYCOMPLETE
完整扫描的快速扫描部分已完成。
MPNOTIFY_INTERNAL_FAILURE
扫描操作遇到一般故障。 MPCALLBACK_DATA中的 hResult 具有特定的错误代码。

phScanHandle [out]

类型: PMPHANDLE

返回的扫描句柄,用于标识当前启动的扫描。 此句柄可用于后续函数调用,例如检索扫描结果。 必须使用 MpHandleClose 函数关闭句柄。

返回值

类型: HRESULT

如果函数成功,则返回值 S_OK

如果函数失败,则返回值是失败的 HRESULT 代码。 调用方可以使用 MpErrorMessageFormat 函数获取错误消息的通用说明。

要求

要求
最低受支持的客户端
Windows 8 [仅限桌面应用]
最低受支持的服务器
Windows Server 2012 [仅限桌面应用]
标头
MpClient.h
DLL
MpClient.dll

请参阅

MpErrorMessageFormat

MpHandleClose

MpManagerOpen

MPCALLBACK_DATA

MPSCAN_DATA

MPSCAN_RESOURCES

MPSCAN_TYPE