MpScanStart, fonction

Démarre une opération d’analyse.

Syntaxe

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

Paramètres

hMpHandle [in]

Type : MPHANDLE

Gérez l’interface du gestionnaire de protection contre les programmes malveillants. Ce handle est retourné par la fonction MpManagerOpen .

ScanType [in]

Type : MPSCAN_TYPE

Spécifie le type d’analyse. Ce paramètre doit être l’un des membres de l’énumération MPSCAN_TYPE .

dwScanOptions [in]

Type : DWORD

Spécifie différentes options pour l’opération d’analyse.

Valeur	Sens
MPSCAN_OPTION_NONE	Aucune option spécifique n’est demandée.
MPSCAN_OPTION_ASYNC	L’opération d’analyse doit être asynchrone, où MpScanStart retourne immédiatement après l’initiation réussie de l’analyse. (Par défaut, l’opération d’analyse est synchrone, ce qui signifie que MpScanStart ne retourne qu’une fois l’analyse terminée.)
MPSCAN_OPTION_PROGRESS	L’appelant est intéressé par la réception des informations de progression de l’analyse via un rappel.
MPSCAN_OPTION_LOWPRIORITY	Effectuez l’analyse avec une faible priorité. (Par défaut, l’opération d’analyse est effectuée avec une priorité normale.)
MPSCAN_OPTION_PACKEDEXES	Analysez les exécutables packés pour détecter les menaces possibles.
MPSCAN_OPTION_ARCHIVES	Analysez le contenu de l’archive pour détecter les menaces possibles. Les archives sont des fichiers avec des extensions telles que .zip, .cabou .tar.
MPSCAN_OPTION_HEURISTICS	Activez l’analyse basée sur l’heuristique. Cela recherche les menaces avec le type de détection défini sur heuristique.
MPSCAN_OPTION_REPORTFRIENDLY	Signaler des éléments conviviaux dans une analyse des ressources. Cela est destiné uniquement à une utilisation interne.
MPSCAN_OPTION_REPORTUNKNOWN	Signaler des éléments inconnus dans une analyse de ressource. Cela est destiné uniquement à une utilisation interne.
MPSCAN_OPTION_NOCONSOLIDATE	Ne consolidez pas les résultats de l’analyse avec la vue globale des menaces. Cela est utile pour un client (tel qu’un client de messagerie) qui souhaite contrôler l’expérience utilisateur de nettoyage par lui-même plutôt que d’autoriser l’expérience utilisateur de nettoyage anti-programme malveillant par défaut. Cela est destiné uniquement à une utilisation interne.

pScanResources [in, facultatif]

Type : PMPSCAN_RESOURCES

Pointeur vers les informations de ressource d’analyse. Ce paramètre doit être NULL pour une analyse rapide. Il s’agit d’un paramètre facultatif pour une analyse complète. Pour une analyse de ressource, ce paramètre doit être spécifié avec au moins une structure d’informations sur les ressources. Pour analyser des ressources spécifiques, l’appelant doit avoir GENERIC_READ autorisation pour la ressource. Voir MPSCAN_RESOURCES.

pCallbackInfo [in, facultatif]

Type : PMPCALLBACK_INFO

Pointeur vers les informations de rappel utilisées pour alimenter le client avec des modifications d’état d’analyse (telles que démarrer et terminer) et des informations de progression. Le MPCALLBACK_DATA passé dans la fonction de rappel signale l’état d’analyse réel et les informations relatives à la progression. Voici une liste de rappels possibles :

Valeur	Sens
MPNOTIFY_SCAN_START	Opération d’analyse démarrée.
MPNOTIFY_SCAN_COMPLETE	Opération d’analyse terminée. Des informations supplémentaires sont disponibles via MPSCAN_DATA structure.
MPNOTIFY_SCAN_PAUSED	L’opération d’analyse est suspendue.
MPNOTIFY_SCAN_RESUMED	L’opération d’analyse a repris à partir de la pause.
MPNOTIFY_SCAN_CANCEL	L’opération d’analyse a été annulée.
MPNOTIFY_SCAN_PROGRESS	Analysez les informations de progression. Des informations supplémentaires (telles que des statistiques de ressources) sont disponibles via MPSCAN_DATA structure.
MPNOTIFY_SCAN_ERROR	Analysez les informations d’erreur pour une ressource spécifique. Les informations sur les ressources spécifiques sont disponibles via MPSCAN_DATA structure.
MPNOTIFY_SCAN_INFECTED	L’analyse a détecté une ressource infectée. Notez que dans la plupart des cas, cela entraînera une menace signalée à la fin de l’analyse. Parfois, il peut ne pas se matérialiser comme une menace en raison d’exclusions. Des informations supplémentaires sur les ressources infectées sont disponibles via MPSCAN_DATA structure.
MPNOTIFY_SCAN_MEMORYSTART	La partie analyse rapide de l’analyse complète a démarré.
MPNOTIFY_SCAN_MEMORYCOMPLETE	Une partie d’analyse rapide de l’analyse complète est terminée.
MPNOTIFY_INTERNAL_FAILURE	L’opération d’analyse a rencontré un échec générique. Le hResult dans MPCALLBACK_DATA a le code d’erreur spécifique.

phScanHandle [out]

Type : PMPHANDLE

Handle d’analyse retourné qui identifie l’analyse actuellement lancée. Ce handle peut être utilisé dans les appels de fonction suivants, par exemple pour récupérer un résultat d’analyse. Le handle doit être fermé avec la fonction MpHandleClose .

Valeur retournée

Type : HRESULT

Si la fonction réussit, la valeur de retour est S_OK.

Si la fonction échoue, la valeur de retour est un code HRESULT ayant échoué. L’appelant peut utiliser la fonction MpErrorMessageFormat pour obtenir une description générique du message d’erreur.

Spécifications

Voir aussi

mpErrorMessageFormat

mpHandleClose

MpManagerOpen

MPCALLBACK_DATA

MPSCAN_DATA

MPSCAN_RESOURCES

MPSCAN_TYPE