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

  • Artigo

Exibe uma mensagem na caixa de diálogo em andamento.

Sintaxe

HRESULT SetLine(
       DWORD   dwLineNum,
  [in] PCWSTR  pwzString,
       BOOL    fCompactPath,
       LPCVOID pvResevered
);

Parâmetros

dwLineNum

Tipo: DWORD

O número de linha no qual o texto deve ser exibido. Atualmente, há três linhas: 1, 2 e 3. Se o sinalizador PROGDLG_AUTOTIME foi incluído no parâmetro dwFlags quando IProgressDialog::StartProgressDialog foi chamado, somente as linhas 1 e 2 podem ser usadas. O tempo estimado será exibido na linha 3.

[in] pwzString

Tipo: PCWSTR

Uma cadeia de caracteres Unicode terminada em nulo que contém o texto.

fCompactPath

Tipo: BOOL

TRUE para ter cadeias de caracteres de caminho compactadas se elas forem muito grandes para caber em uma linha. Os caminhos são compactados com PathCompactPath.

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

Normalmente, essa função é usada para exibir uma mensagem como "Item XXX agora está sendo processado". Normalmente, as mensagens são exibidas nas linhas 1 e 2, com a linha 3 reservada para o tempo estimado.

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