ホーム › UI.Shell › SHQueryRecycleBinW

SHQueryRecycleBinW

関数

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

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

シグネチャ

// SHELL32.dll  (Unicode / -W)
#include <windows.h>

HRESULT SHQueryRecycleBinW(
    LPCWSTR pszRootPath,   // optional
    SHQUERYRBINFO* pSHQueryRBInfo
);

パラメーター

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

戻り値の型: HRESULT

公式ドキュメント

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

戻り値

型: HRESULT

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

解説(Remarks)

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

メモ

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

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

各言語での呼び出し定義

// SHELL32.dll  (Unicode / -W)
#include <windows.h>

HRESULT SHQueryRecycleBinW(
    LPCWSTR pszRootPath,   // optional
    SHQUERYRBINFO* pSHQueryRBInfo
);

[DllImport("SHELL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SHQueryRecycleBinW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszRootPath,   // LPCWSTR optional
    IntPtr pSHQueryRBInfo   // SHQUERYRBINFO* in/out
);

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

' pszRootPath : LPCWSTR optional
' pSHQueryRBInfo : SHQUERYRBINFO* in/out
Declare PtrSafe Function SHQueryRecycleBinW Lib "shell32" ( _
    ByVal pszRootPath As LongPtr, _
    ByVal pSHQueryRBInfo As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHQueryRecycleBinW = Fiddle::Function.new(
  lib['SHQueryRecycleBinW'],
  [
    Fiddle::TYPE_VOIDP,  # pszRootPath : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # pSHQueryRBInfo : SHQUERYRBINFO* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

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

出力引数:

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