Método IBackgroundCopyJob::GetState (bits.h)

  • Artigo

Recupera o estado do trabalho.

Sintaxe

HRESULT GetState(
  [out] BG_JOB_STATE *pVal
);

Parâmetros

[out] pVal

O estado do trabalho. Por exemplo, o estado reflete se o trabalho está com erro, transferindo dados ou suspenso. Para obter uma lista de estados de trabalho, consulte a enumeração BG_JOB_STATE .

Retornar valor

Esse método retorna os seguintes valores HRESULT , bem como outros.

Código de retorno Descrição
S_OK
 O estado do trabalho foi recuperado com êxito.
E_INVALIDARG
 O parâmetro , pJobState, não pode ser NULL.

Comentários

Se você quiser saber quando um trabalho está com erro ou transferiu todos os arquivos no trabalho, você pode usar esse método para sondar o estado do trabalho ou se registrar para receber notificação quando ocorrerem eventos. Para obter detalhes sobre como se registrar para receber a notificação de evento, consulte a interface IBackgroundCopyCallback .

Exemplos

Consulte o código de exemplo para o método IBackgroundCopyManager::GetJob .

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows XP
Servidor mínimo com suporte Windows Server 2003
Plataforma de Destino Windows
Cabeçalho bits.h
Biblioteca Bits.lib
DLL QmgrPrxy.dll

Confira também

BG_JOB_STATE, Determinando o status de um trabalho, IBackgroundCopyCallback