SHQueryRecycleBinA 関数 (shellapi.h)

指定したドライブのごみ箱のサイズとその中のアイテムの数を取得します。

構文

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

パラメーター

[in, optional] pszRootPath

種類: LPCTSTR

ごみ箱が配置されているルート ドライブのパスを格納MAX_PATH最大長の null で終わる文字列のアドレス。 このパラメーターには、ドライブ、フォルダー、およびサブフォルダー名 (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 ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして SHQueryRecycleBin を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional、Windows XP [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	shellapi.h
Library	Shell32.lib
[DLL]	Shell32.dll (バージョン 4.71 以降)

こちらもご覧ください

SHEmptyRecycleBin