Função MpScanStart

Inicia uma operação de verificação.

Sintaxe

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

Identificador para a interface do gerenciador de proteção contra malware. Esse identificador é retornado pela função MpManagerOpen .

ScanType [in]

Tipo: MPSCAN_TYPE

Especifica o tipo de verificação. Esse parâmetro deve ser um dos membros da enueração MPSCAN_TYPE .

dwScanOptions [in]

Tipo: DWORD

Especifica várias opções para a operação de verificação.

Valor Significado
MPSCAN_OPTION_NONE
Nenhuma opção específica é solicitada.
MPSCAN_OPTION_ASYNC
A operação de verificação deve ser assíncrona, em que MpScanStart retorna imediatamente após o início bem-sucedido da verificação. (Por padrão, a operação de verificação é síncrona, o que significa que MpScanStart retornará somente após a conclusão da verificação.)
MPSCAN_OPTION_PROGRESS
O chamador está interessado em receber informações de progresso da verificação por meio de um retorno de chamada.
MPSCAN_OPTION_LOWPRIORITY
Execute a verificação com baixa prioridade. (Por padrão, a operação de verificação é executada com prioridade normal.)
MPSCAN_OPTION_PACKEDEXES
Verifique os executáveis empacotados para possíveis ameaças.
MPSCAN_OPTION_ARCHIVES
Examine o conteúdo do arquivo morto em busca de possíveis ameaças. Arquivos são arquivos com extensões como .zip, .cab ou .tar.
MPSCAN_OPTION_HEURISTICS
Habilite a verificação baseada em heurística. Isso verificará se há ameaças com o tipo de detecção definido como heurística.
MPSCAN_OPTION_REPORTFRIENDLY
Relatar itens amigáveis em uma verificação de recursos. Isso destina-se apenas ao uso interno.
MPSCAN_OPTION_REPORTUNKNOWN
Relatar itens desconhecidos em uma verificação de recursos. Isso destina-se apenas ao uso interno.
MPSCAN_OPTION_NOCONSOLIDATE
Não consolide os resultados da verificação com a exibição global de ameaças. Isso é útil para um cliente (como um cliente de email) que deseja controlar a limpeza da experiência do usuário por si só, em vez de permitir a experiência de usuário de limpeza antimalware padrão. Isso destina-se apenas ao uso interno.

pScanResources [in, opcional]

Tipo: PMPSCAN_RESOURCES

Um ponteiro para as informações do recurso de verificação. Esse parâmetro deve ser NULL para uma verificação rápida. Esse é um parâmetro opcional para uma verificação completa. Para uma verificação de recursos, esse parâmetro deve ser especificado com pelo menos uma estrutura de informações de recurso. Para verificar recursos específicos, o chamador deve ter GENERIC_READ permissão para o recurso. Confira MPSCAN_RESOURCES.

pCallbackInfo [in, opcional]

Tipo: PMPCALLBACK_INFO

Um ponteiro para as informações de retorno de chamada usadas para alimentar o cliente com alterações de estado de verificação (como iniciar e concluir) e informações de progresso. O MPCALLBACK_DATA passado novamente na função de retorno de chamada relata o estado real da verificação e as informações relacionadas ao progresso. Veja a seguir uma lista de possíveis retornos de chamada:

Valor Significado
MPNOTIFY_SCAN_START
Operação de verificação iniciada.
MPNOTIFY_SCAN_COMPLETE
Operação de verificação concluída. Informações adicionais estão disponíveis por meio MPSCAN_DATA estrutura.
MPNOTIFY_SCAN_PAUSED
A operação de verificação está em pausa.
MPNOTIFY_SCAN_RESUMED
Operação de verificação retomada da pausa.
MPNOTIFY_SCAN_CANCEL
A operação de verificação foi cancelada.
MPNOTIFY_SCAN_PROGRESS
Verificar informações de progresso. Informações adicionais (como estatísticas de recursos) estão disponíveis por meio MPSCAN_DATA estrutura.
MPNOTIFY_SCAN_ERROR
Verificar informações de erro para um recurso específico. As informações específicas do recurso estão disponíveis por meio MPSCAN_DATA estrutura.
MPNOTIFY_SCAN_INFECTED
A verificação encontrou um recurso infectado. Observe que, na maioria dos casos, isso resultará em alguma ameaça relatada no final da verificação. Às vezes, ele pode não se materializar como uma ameaça devido a exclusões. Informações adicionais de recursos infectados estão disponíveis por meio MPSCAN_DATA estrutura.
MPNOTIFY_SCAN_MEMORYSTART
A parte de verificação rápida da verificação completa foi iniciada.
MPNOTIFY_SCAN_MEMORYCOMPLETE
A parte de verificação rápida da verificação completa foi concluída.
MPNOTIFY_INTERNAL_FAILURE
A operação de verificação encontrou uma falha genérica. O hResult no MPCALLBACK_DATA tem o código de erro específico.

phScanHandle [out]

Tipo: PMPHANDLE

Identificador de verificação retornado que identifica a verificação iniciada no momento. Esse identificador pode ser usado em chamadas de função subsequentes, como para recuperar um resultado de verificação. O identificador deve ser fechado com a função MpHandleClose .

Valor retornado

Tipo: HRESULT

Se a função tiver êxito, o valor retornado será S_OK.

Se a função falhar, o valor retornado será um código HRESULT com falha. O chamador pode usar a função MpErrorMessageFormat para obter uma descrição genérica da mensagem de erro.

Requisitos

Requisito Valor
Cliente mínimo com suporte
Windows 8 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte
Windows Server 2012 [somente aplicativos da área de trabalho]
Cabeçalho
MpClient.h
DLL
MpClient.dll

Confira também

MpErrorMessageFormat

MpHandleClose

MpManagerOpen

MPCALLBACK_DATA

MPSCAN_DATA

MPSCAN_RESOURCES

MPSCAN_TYPE