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

  • Artigo

Especifica um nome de exibição para o trabalho. Normalmente, você usa o nome de exibição para identificar o trabalho em uma interface do usuário.

Sintaxe

HRESULT SetDisplayName(
  [in] LPCWSTR Val
);

Parâmetros

[in] Val

Cadeia de caracteres terminada em nulo que identifica o trabalho. Não deve ser NULL. O comprimento da cadeia de caracteres é limitado a 256 caracteres, não incluindo o terminador nulo.

Retornar valor

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

Código de retorno Descrição
S_OK
 O nome de exibição foi definido com êxito.
E_INVALIDARG
 O parâmetro pDisplayName não pode ser NULL ou o nome excede 256 caracteres.
BG_E_STRING_TOO_LONG
 O nome de exibição excede 256 caracteres.
BG_E_INVALID_STATE
 O estado do trabalho não pode ser BG_JOB_STATE_CANCELLED ou BG_JOB_STATE_ACKNOWLEDGED.

Comentários

O nome de exibição é originalmente definido quando você cria o trabalho. Para obter detalhes sobre como especificar o nome de exibição ao criar o trabalho, consulte o método IBackgroundCopyManager::CreateJob .

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

IBackgroundCopyJob::GetDisplayName

IBackgroundCopyManager::CreateJob