ホーム › UI.Shell › SHQueryRecycleBinA

SHQueryRecycleBinA

関数

ごみ箱内の項目数と合計サイズを取得する。

DLLSHELL32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// SHELL32.dll  (ANSI / -A)
#include <windows.h>

HRESULT SHQueryRecycleBinA(
    LPCSTR pszRootPath,   // optional
    SHQUERYRBINFO* pSHQueryRBInfo
);

パラメーター

名前	型	方向	説明
pszRootPath	LPCSTR	inoptional	ごみ箱が存在するルートドライブのパスを格納する、最大長 MAX_PATH の null 終端文字列のアドレス。このパラメーターには、ドライブ名、フォルダー名、サブフォルダー名を含む形式の文字列のアドレス(C:\Windows\System...)を指定できます。
pSHQueryRBInfo	SHQUERYRBINFO*	inout	ごみ箱の情報を受け取る SHQUERYRBINFO 構造体のアドレス。この API を呼び出す前に、構造体の cbSize メンバーに構造体のサイズを設定しておく必要があります。

戻り値の型: HRESULT

公式ドキュメント

指定したドライブのごみ箱のサイズと、その中の項目数を取得します。(ANSI)

戻り値

型: HRESULT

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

Windows 2000 では、pszRootPath パラメーターに NULL を渡すと、関数は失敗し、E_INVALIDARG エラーコードを返します。それ以前のバージョンのオペレーティングシステムでは、空文字列または NULL を渡すことができます。pszRootPath に空文字列または NULL が含まれる場合、すべてのドライブ上のすべてのごみ箱に関する情報が取得されます。

メモ

shellapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SHQueryRecycleBin を定義します。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、コンパイルエラーや実行時エラーを引き起こす不整合が生じる可能性があります。詳細については、関数プロトタイプの規約を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// SHELL32.dll  (ANSI / -A)
#include <windows.h>

HRESULT SHQueryRecycleBinA(
    LPCSTR pszRootPath,   // optional
    SHQUERYRBINFO* pSHQueryRBInfo
);

[DllImport("SHELL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int SHQueryRecycleBinA(
    [MarshalAs(UnmanagedType.LPStr)] string pszRootPath,   // LPCSTR optional
    IntPtr pSHQueryRBInfo   // SHQUERYRBINFO* in/out
);

<DllImport("SHELL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHQueryRecycleBinA(
    <MarshalAs(UnmanagedType.LPStr)> pszRootPath As String,   ' LPCSTR optional
    pSHQueryRBInfo As IntPtr   ' SHQUERYRBINFO* in/out
) As Integer
End Function

' pszRootPath : LPCSTR optional
' pSHQueryRBInfo : SHQUERYRBINFO* in/out
Declare PtrSafe Function SHQueryRecycleBinA Lib "shell32" ( _
    ByVal pszRootPath As String, _
    ByVal pSHQueryRBInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHQueryRecycleBinA = ctypes.windll.shell32.SHQueryRecycleBinA
SHQueryRecycleBinA.restype = ctypes.c_int
SHQueryRecycleBinA.argtypes = [
    wintypes.LPCSTR,  # pszRootPath : LPCSTR optional
    ctypes.c_void_p,  # pSHQueryRBInfo : SHQUERYRBINFO* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHQueryRecycleBinA = Fiddle::Function.new(
  lib['SHQueryRecycleBinA'],
  [
    Fiddle::TYPE_VOIDP,  # pszRootPath : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # pSHQueryRBInfo : SHQUERYRBINFO* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn SHQueryRecycleBinA(
        pszRootPath: *const u8,  // LPCSTR optional
        pSHQueryRBInfo: *mut SHQUERYRBINFO  // SHQUERYRBINFO* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi)]
public static extern int SHQueryRecycleBinA([MarshalAs(UnmanagedType.LPStr)] string pszRootPath, IntPtr pSHQueryRBInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHQueryRecycleBinA' -Namespace Win32 -PassThru
# $api::SHQueryRecycleBinA(pszRootPath, pSHQueryRBInfo)

#uselib "SHELL32.dll"
#func global SHQueryRecycleBinA "SHQueryRecycleBinA" sptr, sptr
; SHQueryRecycleBinA pszRootPath, varptr(pSHQueryRBInfo)   ; 戻り値は stat
; pszRootPath : LPCSTR optional -> "sptr"
; pSHQueryRBInfo : SHQUERYRBINFO* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHELL32.dll"
#cfunc global SHQueryRecycleBinA "SHQueryRecycleBinA" str, var
; res = SHQueryRecycleBinA(pszRootPath, pSHQueryRBInfo)
; pszRootPath : LPCSTR optional -> "str"
; pSHQueryRBInfo : SHQUERYRBINFO* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll"
#cfunc global SHQueryRecycleBinA "SHQueryRecycleBinA" str, sptr
; res = SHQueryRecycleBinA(pszRootPath, varptr(pSHQueryRBInfo))
; pszRootPath : LPCSTR optional -> "str"
; pSHQueryRBInfo : SHQUERYRBINFO* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。