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

Fornece uma descrição do trabalho.

Sintaxe

HRESULT SetDescription(
  [in] LPCWSTR Val
);

Parâmetros

[in] Val

Cadeia de caracteres terminada em nulo que fornece informações adicionais sobre o trabalho. O comprimento da cadeia de caracteres é limitado a 1.024 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	A descrição do trabalho foi definida com êxito.
E_INVALIDARG	O parâmetro pDescription não pode ser NULL.
BG_E_STRING_TOO_LONG	A descrição excede 1.024 caracteres.
BG_E_INVALID_STATE	O estado do trabalho não pode ser BG_JOB_STATE_CANCELLED ou BG_JOB_STATE_ACKNOWLEDGED.

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::GetDescription