Compartilhar via


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

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á em erro, transferindo dados ou suspenso. Para obter uma lista de estados de trabalho, consulte a enumeração BG_JOB_STATE .

Valor de retorno

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

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

Observações

Se você quiser saber quando um trabalho está em 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 .

Requirements

Requirement Value
Cliente mínimo suportado Windows XP
Servidor mínimo compatível Windows Server 2003
da Plataforma de Destino Windows
Header bits.h
Library Bits.lib
de DLL QmgrPrxy.dll

Consulte também

BG_JOB_STATE, determinando o status de um trabalho, IBackgroundCopyCallback