Compartir a través de

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

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

Syntax

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 NULL.

Valor devuelto

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

Código de retorno Description
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.

Observaciones

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, vea el método IBackgroundCopyManager::CreateJob .

Requisitos

Requirement Importancia
Cliente mínimo compatible Windows XP
Servidor mínimo admitido Windows Server 2003
de la plataforma de destino de Windows
Header bits.h
Library Bits.lib
DLL de QmgrPrxy.dll

Consulte también

IBackgroundCopyJob::GetDisplayName

IBackgroundCopyManager::CreateJob

  • Last updated on