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

SHFOLDERCUSTOMSETTINGS

構造体
サイズx64: 104 バイト / x86: 60 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
dwSizeDWORD4+0+0構造体のサイズ (バイト単位)。
dwMaskDWORD4+4+4

この構造体から読み取る、またはこの構造体に書き込むフォルダー属性を指定する DWORD 値です。どの構造体メンバーが有効かを示すために、次の値のうち 1 つ以上を使用します。

FCSM_VIEWID

非推奨pvid にフォルダーの GUID が格納されます。

FCSM_WEBVIEWTEMPLATE

非推奨pszWebViewTemplate に、フォルダーの WebView テンプレートへのパスを格納したバッファーへのポインターが格納されます。

FCSM_INFOTIP

pszInfoTip に、フォルダーのインフォチップを格納したバッファーへのポインターが格納されます。

FCSM_CLSID

pclsid にフォルダーの CLSID が格納されます。

FCSM_ICONFILE

pszIconFile に、フォルダーのアイコンを含むファイルへのパスが格納されます。

FCSM_LOGO

pszLogo に、フォルダーのサムネイルアイコンを含むファイルへのパスが格納されます。

FCSM_FLAGS

使用されません。

pvidGUID*8/4+8+8フォルダーの GUID です。
pszWebViewTemplateLPWSTR8/4+16+12フォルダーの WebView テンプレート へのパスを格納した、NULL で終わる文字列へのポインターです。
cchWebViewTemplateDWORD4+24+16SHGetSetFolderCustomSettingsdwReadWrite パラメーターが FCS_READ の場合、これは pszWebViewTemplate バッファーのサイズ (文字数) です。そうでない場合は、そのバッファーから書き込む文字数です。文字列全体を書き込むには、このパラメーターに 0 を設定します。
pszWebViewTemplateVersionLPWSTR8/4+32+20WebView テンプレートのバージョンを格納した、NULL で終わるバッファーへのポインターです。
pszInfoTipLPWSTR8/4+40+24フォルダーのインフォチップのテキストを格納した、NULL で終わるバッファーへのポインターです。
cchInfoTipDWORD4+48+28SHGetSetFolderCustomSettingsdwReadWrite パラメーターが FCS_READ の場合、これは pszInfoTip バッファーのサイズ (文字数) です。そうでない場合は、そのバッファーから書き込む文字数です。文字列全体を書き込むには、このパラメーターに 0 を設定します。
pclsidGUID*8/4+56+32Windows レジストリ内でフォルダーを識別するために使用される CLSID へのポインターです。フォルダーに関するその他の情報は、その CLSID エントリの下のレジストリに格納されます。
dwFlagsDWORD4+64+36使用されません。
pszIconFileLPWSTR8/4+72+40フォルダーのアイコンを含むファイルへのパスを格納した、NULL で終わるバッファーへのポインターです。
cchIconFileDWORD4+80+44SHGetSetFolderCustomSettingsdwReadWrite パラメーターが FCS_READ の場合、これは pszIconFile バッファーのサイズ (文字数) です。そうでない場合は、そのバッファーから書き込む文字数です。文字列全体を書き込むには、このパラメーターに 0 を設定します。
iIconIndexINT4+84+48pszIconFile で指定されたファイル内のアイコンのインデックスです。
pszLogoLPWSTR8/4+88+52フォルダーのロゴ画像を含むファイルへのパスを格納した、NULL で終わるバッファーへのポインターです。この画像はサムネイル表示で使用されます。
cchLogoDWORD4+96+56SHGetSetFolderCustomSettingsdwReadWrite パラメーターが FCS_READ の場合、これは pszLogo バッファーのサイズ (文字数) です。そうでない場合は、そのバッファーから書き込む文字数です。文字列全体を書き込むには、このパラメーターに 0 を設定します。

公式ドキュメント

フォルダーのカスタム設定を保持します。この構造体は SHGetSetFolderCustomSettings 関数で使用されます。

解説(Remarks)

Windows XP Service Pack 2 (SP2) 以前のバージョンでは、この構造体は ANSI 文字列と Unicode 文字列の両方をサポートしていました。Windows Vista 以降のバージョンでは、Unicode 文字列のみがサポートされます。

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

各言語での定義

#include <windows.h>

// SHFOLDERCUSTOMSETTINGS  (x64 104 / x86 60 バイト)
typedef struct SHFOLDERCUSTOMSETTINGS {
    DWORD dwSize;
    DWORD dwMask;
    GUID* pvid;
    LPWSTR pszWebViewTemplate;
    DWORD cchWebViewTemplate;
    LPWSTR pszWebViewTemplateVersion;
    LPWSTR pszInfoTip;
    DWORD cchInfoTip;
    GUID* pclsid;
    DWORD dwFlags;
    LPWSTR pszIconFile;
    DWORD cchIconFile;
    INT iIconIndex;
    LPWSTR pszLogo;
    DWORD cchLogo;
} SHFOLDERCUSTOMSETTINGS;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct SHFOLDERCUSTOMSETTINGS
{
    public uint dwSize;
    public uint dwMask;
    public IntPtr pvid;
    public IntPtr pszWebViewTemplate;
    public uint cchWebViewTemplate;
    public IntPtr pszWebViewTemplateVersion;
    public IntPtr pszInfoTip;
    public uint cchInfoTip;
    public IntPtr pclsid;
    public uint dwFlags;
    public IntPtr pszIconFile;
    public uint cchIconFile;
    public int iIconIndex;
    public IntPtr pszLogo;
    public uint cchLogo;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure SHFOLDERCUSTOMSETTINGS
    Public dwSize As UInteger
    Public dwMask As UInteger
    Public pvid As IntPtr
    Public pszWebViewTemplate As IntPtr
    Public cchWebViewTemplate As UInteger
    Public pszWebViewTemplateVersion As IntPtr
    Public pszInfoTip As IntPtr
    Public cchInfoTip As UInteger
    Public pclsid As IntPtr
    Public dwFlags As UInteger
    Public pszIconFile As IntPtr
    Public cchIconFile As UInteger
    Public iIconIndex As Integer
    Public pszLogo As IntPtr
    Public cchLogo As UInteger
End Structure
import ctypes
from ctypes import wintypes

class SHFOLDERCUSTOMSETTINGS(ctypes.Structure):
    _fields_ = [
        ("dwSize", wintypes.DWORD),
        ("dwMask", wintypes.DWORD),
        ("pvid", ctypes.c_void_p),
        ("pszWebViewTemplate", ctypes.c_void_p),
        ("cchWebViewTemplate", wintypes.DWORD),
        ("pszWebViewTemplateVersion", ctypes.c_void_p),
        ("pszInfoTip", ctypes.c_void_p),
        ("cchInfoTip", wintypes.DWORD),
        ("pclsid", ctypes.c_void_p),
        ("dwFlags", wintypes.DWORD),
        ("pszIconFile", ctypes.c_void_p),
        ("cchIconFile", wintypes.DWORD),
        ("iIconIndex", ctypes.c_int),
        ("pszLogo", ctypes.c_void_p),
        ("cchLogo", wintypes.DWORD),
    ]
#[repr(C)]
pub struct SHFOLDERCUSTOMSETTINGS {
    pub dwSize: u32,
    pub dwMask: u32,
    pub pvid: *mut core::ffi::c_void,
    pub pszWebViewTemplate: *mut core::ffi::c_void,
    pub cchWebViewTemplate: u32,
    pub pszWebViewTemplateVersion: *mut core::ffi::c_void,
    pub pszInfoTip: *mut core::ffi::c_void,
    pub cchInfoTip: u32,
    pub pclsid: *mut core::ffi::c_void,
    pub dwFlags: u32,
    pub pszIconFile: *mut core::ffi::c_void,
    pub cchIconFile: u32,
    pub iIconIndex: i32,
    pub pszLogo: *mut core::ffi::c_void,
    pub cchLogo: u32,
}
import "golang.org/x/sys/windows"

type SHFOLDERCUSTOMSETTINGS struct {
	dwSize uint32
	dwMask uint32
	pvid uintptr
	pszWebViewTemplate uintptr
	cchWebViewTemplate uint32
	pszWebViewTemplateVersion uintptr
	pszInfoTip uintptr
	cchInfoTip uint32
	pclsid uintptr
	dwFlags uint32
	pszIconFile uintptr
	cchIconFile uint32
	iIconIndex int32
	pszLogo uintptr
	cchLogo uint32
}
type
  SHFOLDERCUSTOMSETTINGS = record
    dwSize: DWORD;
    dwMask: DWORD;
    pvid: Pointer;
    pszWebViewTemplate: Pointer;
    cchWebViewTemplate: DWORD;
    pszWebViewTemplateVersion: Pointer;
    pszInfoTip: Pointer;
    cchInfoTip: DWORD;
    pclsid: Pointer;
    dwFlags: DWORD;
    pszIconFile: Pointer;
    cchIconFile: DWORD;
    iIconIndex: Integer;
    pszLogo: Pointer;
    cchLogo: DWORD;
  end;
const SHFOLDERCUSTOMSETTINGS = extern struct {
    dwSize: u32,
    dwMask: u32,
    pvid: ?*anyopaque,
    pszWebViewTemplate: ?*anyopaque,
    cchWebViewTemplate: u32,
    pszWebViewTemplateVersion: ?*anyopaque,
    pszInfoTip: ?*anyopaque,
    cchInfoTip: u32,
    pclsid: ?*anyopaque,
    dwFlags: u32,
    pszIconFile: ?*anyopaque,
    cchIconFile: u32,
    iIconIndex: i32,
    pszLogo: ?*anyopaque,
    cchLogo: u32,
};
type
  SHFOLDERCUSTOMSETTINGS {.bycopy.} = object
    dwSize: uint32
    dwMask: uint32
    pvid: pointer
    pszWebViewTemplate: pointer
    cchWebViewTemplate: uint32
    pszWebViewTemplateVersion: pointer
    pszInfoTip: pointer
    cchInfoTip: uint32
    pclsid: pointer
    dwFlags: uint32
    pszIconFile: pointer
    cchIconFile: uint32
    iIconIndex: int32
    pszLogo: pointer
    cchLogo: uint32
struct SHFOLDERCUSTOMSETTINGS
{
    uint dwSize;
    uint dwMask;
    void* pvid;
    void* pszWebViewTemplate;
    uint cchWebViewTemplate;
    void* pszWebViewTemplateVersion;
    void* pszInfoTip;
    uint cchInfoTip;
    void* pclsid;
    uint dwFlags;
    void* pszIconFile;
    uint cchIconFile;
    int iIconIndex;
    void* pszLogo;
    uint cchLogo;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; SHFOLDERCUSTOMSETTINGS サイズ: 60 バイト(x86)
dim st, 15    ; 4byte整数×15(構造体サイズ 60 / 4 切り上げ)
; dwSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwMask : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; pvid : GUID* (+8, 4byte)  varptr(st)+8 を基点に操作(4byte:入れ子/配列)
; pszWebViewTemplate : LPWSTR (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; cchWebViewTemplate : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; pszWebViewTemplateVersion : LPWSTR (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; pszInfoTip : LPWSTR (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; cchInfoTip : DWORD (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; pclsid : GUID* (+32, 4byte)  varptr(st)+32 を基点に操作(4byte:入れ子/配列)
; dwFlags : DWORD (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; pszIconFile : LPWSTR (+40, 4byte)  st.10 = 値  /  値 = st.10   (lpoke/lpeek も可)
; cchIconFile : DWORD (+44, 4byte)  st.11 = 値  /  値 = st.11   (lpoke/lpeek も可)
; iIconIndex : INT (+48, 4byte)  st.12 = 値  /  値 = st.12   (lpoke/lpeek も可)
; pszLogo : LPWSTR (+52, 4byte)  st.13 = 値  /  値 = st.13   (lpoke/lpeek も可)
; cchLogo : DWORD (+56, 4byte)  st.14 = 値  /  値 = st.14   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; SHFOLDERCUSTOMSETTINGS サイズ: 104 バイト(x64)
dim st, 26    ; 4byte整数×26(構造体サイズ 104 / 4 切り上げ)
; dwSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwMask : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; pvid : GUID* (+8, 8byte)  varptr(st)+8 を基点に操作(8byte:入れ子/配列)
; pszWebViewTemplate : LPWSTR (+16, 8byte)  qpoke st,16,値 / qpeek(st,16)  ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; cchWebViewTemplate : DWORD (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; pszWebViewTemplateVersion : LPWSTR (+32, 8byte)  qpoke st,32,値 / qpeek(st,32)  ※IronHSPのみ。3.7/3.8は lpoke st,32,下位 : lpoke st,36,上位
; pszInfoTip : LPWSTR (+40, 8byte)  qpoke st,40,値 / qpeek(st,40)  ※IronHSPのみ。3.7/3.8は lpoke st,40,下位 : lpoke st,44,上位
; cchInfoTip : DWORD (+48, 4byte)  st.12 = 値  /  値 = st.12   (lpoke/lpeek も可)
; pclsid : GUID* (+56, 8byte)  varptr(st)+56 を基点に操作(8byte:入れ子/配列)
; dwFlags : DWORD (+64, 4byte)  st.16 = 値  /  値 = st.16   (lpoke/lpeek も可)
; pszIconFile : LPWSTR (+72, 8byte)  qpoke st,72,値 / qpeek(st,72)  ※IronHSPのみ。3.7/3.8は lpoke st,72,下位 : lpoke st,76,上位
; cchIconFile : DWORD (+80, 4byte)  st.20 = 値  /  値 = st.20   (lpoke/lpeek も可)
; iIconIndex : INT (+84, 4byte)  st.21 = 値  /  値 = st.21   (lpoke/lpeek も可)
; pszLogo : LPWSTR (+88, 8byte)  qpoke st,88,値 / qpeek(st,88)  ※IronHSPのみ。3.7/3.8は lpoke st,88,下位 : lpoke st,92,上位
; cchLogo : DWORD (+96, 4byte)  st.24 = 値  /  値 = st.24   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global SHFOLDERCUSTOMSETTINGS
    #field int dwSize
    #field int dwMask
    #field intptr pvid
    #field intptr pszWebViewTemplate
    #field int cchWebViewTemplate
    #field intptr pszWebViewTemplateVersion
    #field intptr pszInfoTip
    #field int cchInfoTip
    #field intptr pclsid
    #field int dwFlags
    #field intptr pszIconFile
    #field int cchIconFile
    #field int iIconIndex
    #field intptr pszLogo
    #field int cchLogo
#endstruct

stdim st, SHFOLDERCUSTOMSETTINGS        ; NSTRUCT 変数を確保
st->dwSize = 100
mes "dwSize=" + st->dwSize