Share via


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

Proporciona una descripción del trabajo.

Sintaxis

HRESULT SetDescription(
  [in] LPCWSTR Val
);

Parámetros

[in] Val

Cadena terminada en NULL que proporciona información adicional sobre el trabajo. La longitud de la cadena está limitada a 1024 caracteres, sin incluir el terminador nulo.

Valor devuelto

Este método devuelve los siguientes valores HRESULT , así como otros.

Código devuelto Descripción
S_OK
Descripción del trabajo se estableció correctamente.
E_INVALIDARG
El parámetro pDescription no puede ser NULL.
BG_E_STRING_TOO_LONG
La descripción supera los 1024 caracteres.
BG_E_INVALID_STATE
El estado del trabajo no puede ser BG_JOB_STATE_CANCELLED ni BG_JOB_STATE_ACKNOWLEDGED.

Requisitos

Requisito Value
Cliente mínimo compatible Windows XP
Servidor mínimo compatible Windows Server 2003
Plataforma de destino Windows
Encabezado bits.h
Library Bits.lib
Archivo DLL QmgrPrxy.dll

Consulte también

IBackgroundCopyJob::GetDescription