Método IProgressDialog::SetCancelMsg (shlobj_core.h)

  • Artigo

Define uma mensagem a ser exibida se o usuário cancelar a operação.

Sintaxe

HRESULT SetCancelMsg(
  [in] PCWSTR  pwzCancelMsg,
       LPCVOID pvResevered
);

Parâmetros

[in] pwzCancelMsg

Tipo: PCWSTR

Um ponteiro para uma cadeia de caracteres Unicode terminada em nulo que contém a mensagem a ser exibida.

pvResevered

Tipo: LPCVOID

Reservado. Defina como NULL.

Retornar valor

Tipo: HRESULT

Se o método for bem-sucedido, ele retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Comentários

Embora o usuário clique em Cancelar, o aplicativo não pode chamar IProgressDialog::StopProgressDialog imediatamente para fechar a caixa de diálogo. O aplicativo deve aguardar até a próxima vez que chamar IProgressDialog::HasUserCancelled para descobrir que o usuário cancelou a operação. Como esse atraso pode ser significativo, a caixa de diálogo de progresso fornece ao usuário comentários imediatos limpando as linhas de texto 1 e 2 e exibindo a mensagem de cancelamento na linha 3. A mensagem destina-se a informar ao usuário que o atraso é normal e que a caixa de diálogo de progresso será fechada em breve. Normalmente, é definido como algo como "Por favor, aguarde enquanto ...".

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 2000 Professional, Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho shlobj_core.h
DLL Shell32.dll (versão 5.0 ou posterior)

Confira também

IProgressDialog