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

Chamado se o texto descritivo associado à ação for alterado.

Sintaxe

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

Parâmetros

[in] sptext

Tipo: SPTEXT

Um valor que especifica o tipo de texto exibido. Consulte SPTEXT para obter valores aceitáveis.

[in] pszText

Tipo: LPCWSTR

Um ponteiro para uma cadeia de caracteres larga a ser exibida.

[in] fMayCompact

Tipo: BOOL

Um valor que especifica se uma cadeia de caracteres de texto deve ser compactada para se ajustar ao espaço disponível na tela.

Retornar valor

Tipo: HRESULT

Retorne S_OK se tiver êxito ou um valor de erro, caso contrário.

Comentários

A classe que implementa esse método deve interpretar o valor de sptext e fMayCompact no contexto da ação que está sendo executada e a interface do usuário que mostra o progresso para o usuário. O valor de sptext pode ser usado para diferenciar entre linhas de texto alterável. Geralmente, o valor de fMayCompact refere-se a se a cadeia de caracteres de texto pode ser truncada com reticências (...) para conservar o espaço na tela.

Requisitos

Confira também

IActionProgress

SPTEXT