Função SHEmptyRecycleBinA (shellapi.h)

Artigo
11/20/2024

Esvazia a Lixeira na unidade especificada.

Sintaxe

SHSTDAPI SHEmptyRecycleBinA(
  [in, optional] HWND   hwnd,
  [in, optional] LPCSTR pszRootPath,
                 DWORD  dwFlags
);

Parâmetros

[in, optional] hwnd

Tipo: HWND

Um identificador para a janela pai de qualquer caixa de diálogo que possa ser exibida durante a operação. Esse parâmetro pode ser NULL.

[in, optional] pszRootPath

Tipo: LPCTSTR

O endereço de uma cadeia de caracteres terminada em nulo de comprimento máximo MAX_PATH que contém o caminho da unidade raiz na qual a Lixeira está localizada. Esse parâmetro pode conter o endereço de uma cadeia de caracteres formatada com os nomes de unidade, pasta e subpasta, por exemplo, c:\windows\system. Ele também pode conter uma cadeia de caracteres vazia ou NULL. Se esse valor for uma cadeia de caracteres vazia ou NULL, todas as Lixeiras em todas as unidades serão esvaziadas.

dwFlags

Tipo: DWORD

Um ou mais dos valores a seguir.

SHERB_NOCONFIRMATION

Nenhuma caixa de diálogo que confirme a exclusão dos objetos será exibida.

SHERB_NOPROGRESSUI

Nenhuma caixa de diálogo que indique que o progresso será exibido.

SHERB_NOSOUND

Nenhum som será reproduzido quando a operação for concluída.

Valor de retorno

Tipo: HRESULT

Se essa função for bem-sucedida, ela retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Observações

Nota

O cabeçalho shellapi.h define SHEmptyRecycleBin como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows 2000 Professional, Windows XP [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows 2000 Server [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	shellapi.h
biblioteca	Shell32.lib
de DLL	Shell32.dll (versão 4.71 ou posterior)
conjunto de API	ext-ms-win-shell-shell32-l1-2-2 (introduzido no Windows 10, versão 10.0.14393)

Consulte também

SHQueryRecycleBin

Compartilhar via