Compartir a través de

Método IActionProgress::UpdateText (shobjidl_core.h)

  • Artículo

Se llama si se cambiará el texto descriptivo asociado a la acción.

Sintaxis

HRESULT UpdateText(
  [in] SPTEXT  sptext,
  [in] LPCWSTR pszText,
  [in] BOOL    fMayCompact
);

Parámetros

[in] sptext

Tipo: SPTEXT

Valor que especifica el tipo de texto mostrado. Consulte SPTEXT para obtener valores aceptables.

[in] pszText

Tipo: LPCWSTR

Puntero a una cadena de caracteres anchos que se va a mostrar.

[in] fMayCompact

Tipo: BOOL

Valor que especifica si se va a permitir que una cadena de texto se compacte para ajustarse al espacio disponible en pantalla.

Valor devuelto

Tipo: HRESULT

Devuelve S_OK si se ejecuta correctamente o un valor de error de lo contrario.

Comentarios

La clase que implementa este método debe interpretar el valor de sptext y fMayCompact en el contexto de la acción que se realiza y la interfaz de usuario que muestra el progreso al usuario. El valor de sptext se puede usar para diferenciar entre líneas de texto modificable. A menudo, el valor de fMayCompact hace referencia a si la cadena de texto se puede truncar con puntos suspensivos (...) para ahorrar espacio en pantalla.

Requisitos

Requisito Value
Cliente mínimo compatible Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado shobjidl_core.h (include Shobjidl.h)
Archivo DLL Shobjidl.idl

Consulte también

IActionProgress

SPTEXT