Função SHQueryRecycleBinW (shellapi.h)

  • Artigo

Recupera o tamanho da Lixeira e o número de itens nela, para uma unidade especificada.

Sintaxe

SHSTDAPI SHQueryRecycleBinW(
  [in, optional] LPCWSTR         pszRootPath,
  [in, out]      LPSHQUERYRBINFO pSHQueryRBInfo
);

Parâmetros

[in, optional] pszRootPath

Tipo: LPCTSTR

O endereço de uma cadeia de caracteres terminada em nulo de comprimento máximo MAX_PATH para conter 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 (C:\Windows\System...).

[in, out] pSHQueryRBInfo

Tipo: LPSHQUERYRBINFO

O endereço de uma estrutura SHQUERYRBINFO que recebe as informações da Lixeira. O membro cbSize da estrutura deve ser definido como o tamanho da estrutura antes de chamar essa API.

Retornar valor

Tipo: HRESULT

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

Comentários

Com o Windows 2000, se NULL for passado no parâmetro pszRootPath , a função falhará e retornará um código de erro E_INVALIDARG. Em versões anteriores do sistema operacional, você pode passar uma cadeia de caracteres vazia ou NULL. Se pszRootPath contiver uma cadeia de caracteres vazia ou NULL, as informações serão recuperadas para todas as Lixeiras em todas as unidades.

Observação

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

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 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho shellapi.h
Biblioteca Shell32.lib
DLL Shell32.dll (versão 4.71 ou posterior)

Confira também

SHEmptyRecycleBin