SHQueryRecycleBinA 函式 (shellapi.h)

  • 發行項

擷取指定磁碟驅動器的回收站大小及其項目數目。

語法

SHSTDAPI SHQueryRecycleBinA(
  [in, optional] LPCSTR          pszRootPath,
  [in, out]      LPSHQUERYRBINFO pSHQueryRBInfo
);

參數

[in, optional] pszRootPath

類型： LPCTSTR

長度上限的 Null 終止字串位址，MAX_PATH包含回收站所在根磁碟驅動器的路徑。 此參數可以包含格式化為磁碟驅動器、資料夾和子資料夾名稱的字串位址， (C：\Windows\System...) 。

[in, out] pSHQueryRBInfo

類型： LPSHQUERYRBINFO

接收回收站資訊的 SHQUERYRBINFO 結構位址。 結構的 cbSize 成員必須先設定為 結構的大小，才能呼叫此 API。

傳回值

類型： HRESULT

如果此函式成功，則會傳回 S_OK。 否則，它會傳回 HRESULT 錯誤碼。

備註

使用 Windows 2000 時，如果在 pszRootPath 參數中傳遞 NULL，函式會失敗並傳回E_INVALIDARG錯誤碼。 在舊版的作業系統中，您可以傳遞空字串或 NULL。 如果 pszRootPath 包含空字串或 NULL，則會擷取所有磁碟驅動器上所有回收站的資訊。

注意

shellapi.h 標頭會將SHQueryRecycleBin定義為別名，根據UNICODE預處理器常數的定義，自動選取此函式的ANSI或Unicode版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。

規格需求

需求 值
最低支援的用戶端 Windows 2000 Professional、Windows XP [僅限桌面應用程式]
最低支援的伺服器 Windows 2000 Server [僅限桌面應用程式]
目標平台 Windows
標頭 shellapi.h
程式庫 Shell32.lib
Dll Shell32.dll (4.71 版或更新版本)

另請參閱

SHEmptyRecycleBin