Win32 API 日本語リファレンス
ホームUI.Shell › SHGetViewStatePropertyBag

SHGetViewStatePropertyBag

関数
フォルダーの表示状態を保持するプロパティバッグを取得する。
DLLSHLWAPI.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// SHLWAPI.dll
#include <windows.h>

HRESULT SHGetViewStatePropertyBag(
    ITEMIDLIST* pidl,   // optional
    LPCWSTR pszBagName,   // optional
    DWORD dwFlags,
    const GUID* riid,
    void** ppv
);

パラメーター

名前方向
pidlITEMIDLIST*inoptional
pszBagNameLPCWSTRinoptional
dwFlagsDWORDin
riidGUID*in
ppvvoid**out

戻り値の型: HRESULT

各言語での呼び出し定義

// SHLWAPI.dll
#include <windows.h>

HRESULT SHGetViewStatePropertyBag(
    ITEMIDLIST* pidl,   // optional
    LPCWSTR pszBagName,   // optional
    DWORD dwFlags,
    const GUID* riid,
    void** ppv
);
[DllImport("SHLWAPI.dll", ExactSpelling = true)]
static extern int SHGetViewStatePropertyBag(
    IntPtr pidl,   // ITEMIDLIST* optional
    [MarshalAs(UnmanagedType.LPWStr)] string pszBagName,   // LPCWSTR optional
    uint dwFlags,   // DWORD
    ref Guid riid,   // GUID*
    IntPtr ppv   // void** out
);
<DllImport("SHLWAPI.dll", ExactSpelling:=True)>
Public Shared Function SHGetViewStatePropertyBag(
    pidl As IntPtr,   ' ITEMIDLIST* optional
    <MarshalAs(UnmanagedType.LPWStr)> pszBagName As String,   ' LPCWSTR optional
    dwFlags As UInteger,   ' DWORD
    ByRef riid As Guid,   ' GUID*
    ppv As IntPtr   ' void** out
) As Integer
End Function
' pidl : ITEMIDLIST* optional
' pszBagName : LPCWSTR optional
' dwFlags : DWORD
' riid : GUID*
' ppv : void** out
Declare PtrSafe Function SHGetViewStatePropertyBag Lib "shlwapi" ( _
    ByVal pidl As LongPtr, _
    ByVal pszBagName As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal riid As LongPtr, _
    ByVal ppv As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHGetViewStatePropertyBag = ctypes.windll.shlwapi.SHGetViewStatePropertyBag
SHGetViewStatePropertyBag.restype = ctypes.c_int
SHGetViewStatePropertyBag.argtypes = [
    ctypes.c_void_p,  # pidl : ITEMIDLIST* optional
    wintypes.LPCWSTR,  # pszBagName : LPCWSTR optional
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # ppv : void** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHGetViewStatePropertyBag = Fiddle::Function.new(
  lib['SHGetViewStatePropertyBag'],
  [
    Fiddle::TYPE_VOIDP,  # pidl : ITEMIDLIST* optional
    Fiddle::TYPE_VOIDP,  # pszBagName : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    Fiddle::TYPE_VOIDP,  # ppv : void** out
  ],
  Fiddle::TYPE_INT)
#[link(name = "shlwapi")]
extern "system" {
    fn SHGetViewStatePropertyBag(
        pidl: *mut ITEMIDLIST,  // ITEMIDLIST* optional
        pszBagName: *const u16,  // LPCWSTR optional
        dwFlags: u32,  // DWORD
        riid: *const GUID,  // GUID*
        ppv: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll")]
public static extern int SHGetViewStatePropertyBag(IntPtr pidl, [MarshalAs(UnmanagedType.LPWStr)] string pszBagName, uint dwFlags, ref Guid riid, IntPtr ppv);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHGetViewStatePropertyBag' -Namespace Win32 -PassThru
# $api::SHGetViewStatePropertyBag(pidl, pszBagName, dwFlags, riid, ppv)
#uselib "SHLWAPI.dll"
#func global SHGetViewStatePropertyBag "SHGetViewStatePropertyBag" sptr, sptr, sptr, sptr, sptr
; SHGetViewStatePropertyBag varptr(pidl), pszBagName, dwFlags, varptr(riid), ppv   ; 戻り値は stat
; pidl : ITEMIDLIST* optional -> "sptr"
; pszBagName : LPCWSTR optional -> "sptr"
; dwFlags : DWORD -> "sptr"
; riid : GUID* -> "sptr"
; ppv : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global SHGetViewStatePropertyBag "SHGetViewStatePropertyBag" var, wstr, int, var, sptr
; res = SHGetViewStatePropertyBag(pidl, pszBagName, dwFlags, riid, ppv)
; pidl : ITEMIDLIST* optional -> "var"
; pszBagName : LPCWSTR optional -> "wstr"
; dwFlags : DWORD -> "int"
; riid : GUID* -> "var"
; ppv : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT SHGetViewStatePropertyBag(ITEMIDLIST* pidl, LPCWSTR pszBagName, DWORD dwFlags, GUID* riid, void** ppv)
#uselib "SHLWAPI.dll"
#cfunc global SHGetViewStatePropertyBag "SHGetViewStatePropertyBag" var, wstr, int, var, intptr
; res = SHGetViewStatePropertyBag(pidl, pszBagName, dwFlags, riid, ppv)
; pidl : ITEMIDLIST* optional -> "var"
; pszBagName : LPCWSTR optional -> "wstr"
; dwFlags : DWORD -> "int"
; riid : GUID* -> "var"
; ppv : void** out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHGetViewStatePropertyBag = shlwapi.NewProc("SHGetViewStatePropertyBag")
)

// pidl (ITEMIDLIST* optional), pszBagName (LPCWSTR optional), dwFlags (DWORD), riid (GUID*), ppv (void** out)
r1, _, err := procSHGetViewStatePropertyBag.Call(
	uintptr(pidl),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszBagName))),
	uintptr(dwFlags),
	uintptr(riid),
	uintptr(ppv),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function SHGetViewStatePropertyBag(
  pidl: Pointer;   // ITEMIDLIST* optional
  pszBagName: PWideChar;   // LPCWSTR optional
  dwFlags: DWORD;   // DWORD
  riid: PGUID;   // GUID*
  ppv: Pointer   // void** out
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'SHGetViewStatePropertyBag';
result := DllCall("SHLWAPI\SHGetViewStatePropertyBag"
    , "Ptr", pidl   ; ITEMIDLIST* optional
    , "WStr", pszBagName   ; LPCWSTR optional
    , "UInt", dwFlags   ; DWORD
    , "Ptr", riid   ; GUID*
    , "Ptr", ppv   ; void** out
    , "Int")   ; return: HRESULT
●SHGetViewStatePropertyBag(pidl, pszBagName, dwFlags, riid, ppv) = DLL("SHLWAPI.dll", "int SHGetViewStatePropertyBag(void*, char*, dword, void*, void*)")
# 呼び出し: SHGetViewStatePropertyBag(pidl, pszBagName, dwFlags, riid, ppv)
# pidl : ITEMIDLIST* optional -> "void*"
# pszBagName : LPCWSTR optional -> "char*"
# dwFlags : DWORD -> "dword"
# riid : GUID* -> "void*"
# ppv : void** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。