Compartir a través de

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

  • Artículo

Especifica un nombre para mostrar para el trabajo. Normalmente, se usa el nombre para mostrar para identificar el trabajo en una interfaz de usuario.

Sintaxis

HRESULT SetDisplayName(
  [in] LPCWSTR Val
);

Parámetros

[in] Val

Cadena terminada en NULL que identifica el trabajo. No debe ser NULL. La longitud de la cadena está limitada a 256 caracteres, no incluido el terminador nulo.

Valor devuelto

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

Código devuelto Descripción
S_OK
 El nombre para mostrar se estableció correctamente.
E_INVALIDARG
 El parámetro pDisplayName no puede ser NULL o el nombre supera los 256 caracteres.
BG_E_STRING_TOO_LONG
 El nombre para mostrar supera los 256 caracteres.
BG_E_INVALID_STATE
 El estado del trabajo no puede ser BG_JOB_STATE_CANCELLED ni BG_JOB_STATE_ACKNOWLEDGED.

Comentarios

El nombre para mostrar se establece originalmente al crear el trabajo. Para obtener más información sobre cómo especificar el nombre para mostrar al crear el trabajo, consulte el método IBackgroundCopyManager::CreateJob .

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

IBackgroundCopyManager::CreateJob