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プロパティを要求するフォルダーの PIDL です。SHGVSPB_ALLFOLDERS フラグを渡す場合、このパラメーターは NULL でなければなりません。
pszBagNameLPCWSTRinoptional要求するプロパティバッグの名前を格納する文字列へのポインターです。
dwFlagsDWORDin

次のフラグの組み合わせを指定する値です。

次のフラグのセットから 1 つの値が必要です。

SHGVSPB_PERUSER

指定した pidl のユーザー単位のプロパティを返します。

SHGVSPB_ALLUSERS

指定した pidl の全ユーザー共通のプロパティを返します。

次のフラグのセットから 1 つの値が必要です。

SHGVSPB_PERFOLDER

pidl パラメーターで指定したフォルダーのプロパティバッグを返します。

SHGVSPB_ALLFOLDERS

すべてのフォルダーに適用されるプロパティバッグを返します。

SHGVSPB_INHERIT

独自のプロパティバッグを持たないサブフォルダーに既定値を提供するために使用されるプロパティバッグを返します。

次のフラグは省略可能です。

SHGVSPB_ROAM

プロパティバッグのローミングを許可します。Roaming User Profiles を参照してください。このフラグは SHGVSPB_ALLFOLDERS と組み合わせることはできません。

SHGVSPB_NOAUTODEFAULTS

指定したフォルダーのプロパティバッグが見つからない場合に、適切な既定値の検索を抑制します。既定では、SHGVSPB_INHERIT が指定されておらず、指定したフォルダーのプロパティバッグが見つからない場合、システムは既定値を提供できる可能性のある他の場所で同名のプロパティバッグを検索します。たとえば、システムはフォルダーの上位フォルダーを検索して、それらが SHGVSPB_INHERIT プロパティバッグを提供しているかどうかを確認します。システムが検索するその他の場所は、ユーザー既定値とグローバル既定値です。

次のフラグのセットは、上記のいくつかのフラグを組み合わせた値で構成されており、簡潔さと利便性のために使用されます。

SHGVSPB_FOLDER

SHGVSPB_PERUSERSHGVSPB_PERFOLDER を組み合わせます。

SHGVSPB_FOLDERNODEFAULTS

SHGVSPB_PERUSERSHGVSPB_PERFOLDERSHGVSPB_NOAUTODEFAULTS を組み合わせます。

SHGVSPB_USERDEFAULTS

SHGVSPB_PERUSERSHGVSPB_ALLFOLDERS を組み合わせます。

SHGVSPB_GLOBALDEFAULTS

SHGVSPB_ALLUSERSSHGVSPB_ALLFOLDERS を組み合わせます。

Windows Server 2008、Windows Vista、Windows Server 2003 および Windows XP: このフラグは SHGVSPB_GLOBALDEAFAULTS という名前です。

riidGUID*inppv を通じて取得するインターフェイスの IID への参照です。
ppvvoid**outこのメソッドが正常に返ると、riid で要求したインターフェイスポインターを格納します。

戻り値の型: HRESULT

公式ドキュメント

SHGetViewStatePropertyBag は変更される場合、または利用できなくなる場合があります。

戻り値

型: HRESULT

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

解説(Remarks)

システムは限られた数のビューステートしか保持しないため、重要な情報をビューステートプロパティバッグに格納しないでください。フォルダーが長期間アクセスされない場合、そのビューステートは最終的に削除されます。

riidppv パラメーターをまとめるには、Objbase.h で定義されている IID_PPV_ARGS マクロを使用することをお勧めします。このマクロは ppv の値が指すインターフェイスに基づいて正しい IID を提供するため、riid のコーディングエラーによって予期しない結果が生じる可能性を排除します。

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

各言語での呼び出し定義

// 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)。
const std = @import("std");

extern "shlwapi" fn SHGetViewStatePropertyBag(
    pidl: [*c]ITEMIDLIST, // ITEMIDLIST* optional
    pszBagName: [*c]const u16, // LPCWSTR optional
    dwFlags: u32, // DWORD
    riid: [*c]GUID, // GUID*
    ppv: ?*anyopaque // void** out
) callconv(std.os.windows.WINAPI) i32;
proc SHGetViewStatePropertyBag(
    pidl: ptr ITEMIDLIST,  # ITEMIDLIST* optional
    pszBagName: WideCString,  # LPCWSTR optional
    dwFlags: uint32,  # DWORD
    riid: ptr GUID,  # GUID*
    ppv: pointer  # void** out
): int32 {.importc: "SHGetViewStatePropertyBag", stdcall, dynlib: "SHLWAPI.dll".}
pragma(lib, "shlwapi");
extern(Windows)
int SHGetViewStatePropertyBag(
    ITEMIDLIST* pidl,   // ITEMIDLIST* optional
    const(wchar)* pszBagName,   // LPCWSTR optional
    uint dwFlags,   // DWORD
    GUID* riid,   // GUID*
    void** ppv   // void** out
);
ccall((:SHGetViewStatePropertyBag, "SHLWAPI.dll"), stdcall, Int32,
      (Ptr{ITEMIDLIST}, Cwstring, UInt32, Ptr{GUID}, Ptr{Cvoid}),
      pidl, pszBagName, dwFlags, riid, ppv)
# pidl : ITEMIDLIST* optional -> Ptr{ITEMIDLIST}
# pszBagName : LPCWSTR optional -> Cwstring
# dwFlags : DWORD -> UInt32
# riid : GUID* -> Ptr{GUID}
# ppv : void** out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SHGetViewStatePropertyBag(
    void* pidl,
    const uint16_t* pszBagName,
    uint32_t dwFlags,
    void* riid,
    void** ppv);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHGetViewStatePropertyBag(pidl, pszBagName, dwFlags, riid, ppv)
-- pidl : ITEMIDLIST* optional
-- pszBagName : LPCWSTR optional
-- dwFlags : DWORD
-- riid : GUID*
-- ppv : void** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const SHGetViewStatePropertyBag = lib.func('__stdcall', 'SHGetViewStatePropertyBag', 'int32_t', ['void *', 'str16', 'uint32_t', 'void *', 'void *']);
// SHGetViewStatePropertyBag(pidl, pszBagName, dwFlags, riid, ppv)
// pidl : ITEMIDLIST* optional -> 'void *'
// pszBagName : LPCWSTR optional -> 'str16'
// dwFlags : DWORD -> 'uint32_t'
// riid : GUID* -> 'void *'
// ppv : void** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  SHGetViewStatePropertyBag: { parameters: ["pointer", "buffer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SHGetViewStatePropertyBag(pidl, pszBagName, dwFlags, riid, ppv)
// pidl : ITEMIDLIST* optional -> "pointer"
// pszBagName : LPCWSTR optional -> "buffer"
// dwFlags : DWORD -> "u32"
// riid : GUID* -> "pointer"
// ppv : void** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SHGetViewStatePropertyBag(
    void* pidl,
    const uint16_t* pszBagName,
    uint32_t dwFlags,
    void* riid,
    void** ppv);
C, "SHLWAPI.dll");
// $ffi->SHGetViewStatePropertyBag(pidl, pszBagName, dwFlags, riid, ppv);
// pidl : ITEMIDLIST* optional
// pszBagName : LPCWSTR optional
// dwFlags : DWORD
// riid : GUID*
// ppv : void** out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Shlwapi extends StdCallLibrary {
    Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class);
    int SHGetViewStatePropertyBag(
        Pointer pidl,   // ITEMIDLIST* optional
        WString pszBagName,   // LPCWSTR optional
        int dwFlags,   // DWORD
        Pointer riid,   // GUID*
        Pointer ppv   // void** out
    );
}
@[Link("shlwapi")]
lib LibSHLWAPI
  fun SHGetViewStatePropertyBag = SHGetViewStatePropertyBag(
    pidl : ITEMIDLIST*,   # ITEMIDLIST* optional
    pszBagName : UInt16*,   # LPCWSTR optional
    dwFlags : UInt32,   # DWORD
    riid : GUID*,   # GUID*
    ppv : Void**   # void** out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHGetViewStatePropertyBagNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Uint32, Pointer<Void>, Pointer<Void>);
typedef SHGetViewStatePropertyBagDart = int Function(Pointer<Void>, Pointer<Utf16>, int, Pointer<Void>, Pointer<Void>);
final SHGetViewStatePropertyBag = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHGetViewStatePropertyBagNative, SHGetViewStatePropertyBagDart>('SHGetViewStatePropertyBag');
// pidl : ITEMIDLIST* optional -> Pointer<Void>
// pszBagName : LPCWSTR optional -> Pointer<Utf16>
// dwFlags : DWORD -> Uint32
// riid : GUID* -> Pointer<Void>
// ppv : void** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHGetViewStatePropertyBag"
  c_SHGetViewStatePropertyBag :: Ptr () -> CWString -> Word32 -> Ptr () -> Ptr () -> IO Int32
-- pidl : ITEMIDLIST* optional -> Ptr ()
-- pszBagName : LPCWSTR optional -> CWString
-- dwFlags : DWORD -> Word32
-- riid : GUID* -> Ptr ()
-- ppv : void** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shgetviewstatepropertybag =
  foreign "SHGetViewStatePropertyBag"
    ((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* pidl : ITEMIDLIST* optional -> (ptr void) *)
(* pszBagName : LPCWSTR optional -> (ptr uint16_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* riid : GUID* -> (ptr void) *)
(* ppv : void** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("SHGetViewStatePropertyBag" shget-view-state-property-bag :convention :stdcall) :int32
  (pidl :pointer)   ; ITEMIDLIST* optional
  (psz-bag-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (dw-flags :uint32)   ; DWORD
  (riid :pointer)   ; GUID*
  (ppv :pointer))   ; void** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHGetViewStatePropertyBag = Win32::API::More->new('SHLWAPI',
    'int SHGetViewStatePropertyBag(LPVOID pidl, LPCWSTR pszBagName, DWORD dwFlags, LPVOID riid, LPVOID ppv)');
# my $ret = $SHGetViewStatePropertyBag->Call($pidl, $pszBagName, $dwFlags, $riid, $ppv);
# pidl : ITEMIDLIST* optional -> LPVOID
# pszBagName : LPCWSTR optional -> LPCWSTR
# dwFlags : DWORD -> DWORD
# riid : GUID* -> LPVOID
# ppv : void** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型