Compartir a través de


Función MpScanStart

Inicia una operación de examen.

Sintaxis

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
);

Parámetros

hMpHandle [in]

Tipo: MPHANDLE

Controle la interfaz del administrador de protección contra malware. La función MpManagerOpen devuelve este identificador.

ScanType [in]

Tipo: MPSCAN_TYPE

Especifica el tipo de examen. Este parámetro debe ser uno de los miembros de la MPSCAN_TYPE enueration.

dwScanOptions [in]

Tipo: DWORD

Especifica varias opciones para la operación de examen.

Value Significado
MPSCAN_OPTION_NONE
No se solicita ninguna opción específica.
MPSCAN_OPTION_ASYNC
La operación de examen es asincrónica, donde MpScanStart vuelve inmediatamente después del inicio correcto del examen. (De forma predeterminada, la operación de examen es sincrónica, lo que significa que MpScanStart solo devolverá una vez finalizado el examen).
MPSCAN_OPTION_PROGRESS
El autor de la llamada está interesado en recibir información de progreso del examen a través de una devolución de llamada.
MPSCAN_OPTION_LOWPRIORITY
Realice el examen con prioridad baja. (De forma predeterminada, la operación de examen se realiza con prioridad normal).
MPSCAN_OPTION_PACKEDEXES
Examine los ejecutables empaquetados para detectar posibles amenazas.
MPSCAN_OPTION_ARCHIVES
Examine el contenido del archivo para detectar posibles amenazas. Los archivos son archivos con extensiones como .zip, .cab o .tar.
MPSCAN_OPTION_HEURISTICS
Habilite el examen basado en heurística. Esto buscará amenazas con el tipo de detección establecido en heurística.
MPSCAN_OPTION_REPORTFRIENDLY
Informe de elementos descriptivos en un examen de recursos. Esto está pensado solo para uso interno.
MPSCAN_OPTION_REPORTUNKNOWN
Informe de elementos desconocidos en un examen de recursos. Esto está pensado solo para uso interno.
MPSCAN_OPTION_NOCONSOLIDATE
No consolide los resultados del examen con la vista de amenazas global. Esto es útil para un cliente (por ejemplo, un cliente de correo electrónico) que quiere controlar la experiencia de usuario de limpieza por sí mismo en lugar de permitir la experiencia de usuario predeterminada de limpieza antimalware. Esto está pensado solo para uso interno.

pScanResources [in, optional]

Tipo: PMPSCAN_RESOURCES

Puntero a la información del recurso de examen. Este parámetro debe ser NULL para un examen rápido. Se trata de un parámetro opcional para un examen completo. Para un examen de recursos, este parámetro debe especificarse con al menos una estructura de información de recursos. Para examinar recursos específicos, el autor de la llamada debe tener GENERIC_READ permiso para el recurso. Consulte MPSCAN_RESOURCES.

pCallbackInfo [in, optional]

Tipo: PMPCALLBACK_INFO

Puntero a la información de devolución de llamada utilizada para alimentar al cliente con cambios de estado de examen (por ejemplo, inicio y completado) e información de progreso. El MPCALLBACK_DATA pasado en la función de devolución de llamada notifica el estado real del examen y la información relacionada con el progreso. A continuación se muestra una lista de posibles devoluciones de llamada:

Value Significado
MPNOTIFY_SCAN_START
Se inició la operación de examen.
MPNOTIFY_SCAN_COMPLETE
Operación de examen completada. Hay información adicional disponible a través de MPSCAN_DATA estructura.
MPNOTIFY_SCAN_PAUSED
La operación de examen está en pausa.
MPNOTIFY_SCAN_RESUMED
La operación de examen se reanudó desde la pausa.
MPNOTIFY_SCAN_CANCEL
Se canceló la operación de examen.
MPNOTIFY_SCAN_PROGRESS
Examinar la información de progreso. Hay información adicional (como estadísticas de recursos) disponible a través de MPSCAN_DATA estructura.
MPNOTIFY_SCAN_ERROR
Examine la información de error de un recurso específico. La información de recursos específica está disponible a través de MPSCAN_DATA estructura.
MPNOTIFY_SCAN_INFECTED
El examen encontró un recurso infectado. Tenga en cuenta que, en la mayoría de los casos, esto dará lugar a alguna amenaza notificada al final del examen. A veces puede no materializarse como una amenaza debido a exclusiones. La información adicional sobre recursos infectados está disponible a través de MPSCAN_DATA estructura.
MPNOTIFY_SCAN_MEMORYSTART
Se ha iniciado la parte de examen rápido del examen completo.
MPNOTIFY_SCAN_MEMORYCOMPLETE
Se ha completado la parte del examen rápido del examen completo.
MPNOTIFY_INTERNAL_FAILURE
La operación de examen ha encontrado un error genérico. El hResult de MPCALLBACK_DATA tiene el código de error específico.

phScanHandle [out]

Tipo: PMPHANDLE

Identificador de examen devuelto que identifica el examen iniciado actualmente. Este identificador se puede usar en llamadas de función posteriores, como para recuperar un resultado del examen. El identificador debe cerrarse con la función MpHandleClose .

Valor devuelto

Tipo: HRESULT

Si la función se ejecuta correctamente, el valor devuelto es S_OK.

Si se produce un error en la función, el valor devuelto es un código HRESULT con error. El llamador puede usar la función MpErrorMessageFormat para obtener una descripción genérica del mensaje de error.

Requisitos

Requisito Value
Cliente mínimo compatible
Windows 8 [solo aplicaciones de escritorio]
Servidor mínimo compatible
Windows Server 2012 [solo aplicaciones de escritorio]
Encabezado
MpClient.h
Archivo DLL
MpClient.dll

Consulte también

MpErrorMessageFormat

MpHandleClose

MpManagerOpen

MPCALLBACK_DATA

MPSCAN_DATA

MPSCAN_RESOURCES

MPSCAN_TYPE