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

SHGetSetFolderCustomSettings

関数
フォルダーのカスタム設定を取得または設定する。
DLLSHELL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT SHGetSetFolderCustomSettings(
    SHFOLDERCUSTOMSETTINGS* pfcs,
    LPCWSTR pszPath,
    DWORD dwReadWrite
);

パラメーター

名前方向説明
pfcsSHFOLDERCUSTOMSETTINGS*inoutカスタムフォルダー設定を提供または受け取る SHFOLDERCUSTOMSETTINGS 構造体へのポインターです。
pszPathLPCWSTRinフォルダーへのパスを格納する、null で終わる Unicode 文字列へのポインターです。pszPath の長さは、終端の null 文字を含めて MAX_PATH 以下でなければなりません。
dwReadWriteDWORDin

この関数の動作を制御するフラグです。次のいずれかの値を指定できます。

FCS_READ (0x00000001)

カスタムフォルダー設定を pfcs に取得します。

FCS_FORCEWRITE (0x00000002)

値が既に存在するかどうかにかかわらず、pfcs を使用してカスタムフォルダーの設定を設定します。

FCS_WRITE (FCS_READ | FCS_FORCEWRITE)

値がまだ存在しない場合に、pfcs を使用してカスタムフォルダーの設定を設定します。

戻り値の型: HRESULT

公式ドキュメント

SHGetSetFolderCustomSettings は変更されるか、利用できなくなる可能性があります。

戻り値

型: HRESULT

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

解説(Remarks)

Unicode 文字列のみがサポートされています。

Windows Server 2003 および Windows XP: SHGetSetFolderCustomSettings は ANSI 文字列と Unicode 文字列の両方をサポートします。

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

各言語での呼び出し定義

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

HRESULT SHGetSetFolderCustomSettings(
    SHFOLDERCUSTOMSETTINGS* pfcs,
    LPCWSTR pszPath,
    DWORD dwReadWrite
);
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHGetSetFolderCustomSettings(
    IntPtr pfcs,   // SHFOLDERCUSTOMSETTINGS* in/out
    [MarshalAs(UnmanagedType.LPWStr)] string pszPath,   // LPCWSTR
    uint dwReadWrite   // DWORD
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHGetSetFolderCustomSettings(
    pfcs As IntPtr,   ' SHFOLDERCUSTOMSETTINGS* in/out
    <MarshalAs(UnmanagedType.LPWStr)> pszPath As String,   ' LPCWSTR
    dwReadWrite As UInteger   ' DWORD
) As Integer
End Function
' pfcs : SHFOLDERCUSTOMSETTINGS* in/out
' pszPath : LPCWSTR
' dwReadWrite : DWORD
Declare PtrSafe Function SHGetSetFolderCustomSettings Lib "shell32" ( _
    ByVal pfcs As LongPtr, _
    ByVal pszPath As LongPtr, _
    ByVal dwReadWrite As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHGetSetFolderCustomSettings = ctypes.windll.shell32.SHGetSetFolderCustomSettings
SHGetSetFolderCustomSettings.restype = ctypes.c_int
SHGetSetFolderCustomSettings.argtypes = [
    ctypes.c_void_p,  # pfcs : SHFOLDERCUSTOMSETTINGS* in/out
    wintypes.LPCWSTR,  # pszPath : LPCWSTR
    wintypes.DWORD,  # dwReadWrite : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHGetSetFolderCustomSettings = shell32.NewProc("SHGetSetFolderCustomSettings")
)

// pfcs (SHFOLDERCUSTOMSETTINGS* in/out), pszPath (LPCWSTR), dwReadWrite (DWORD)
r1, _, err := procSHGetSetFolderCustomSettings.Call(
	uintptr(pfcs),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszPath))),
	uintptr(dwReadWrite),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function SHGetSetFolderCustomSettings(
  pfcs: Pointer;   // SHFOLDERCUSTOMSETTINGS* in/out
  pszPath: PWideChar;   // LPCWSTR
  dwReadWrite: DWORD   // DWORD
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHGetSetFolderCustomSettings';
result := DllCall("SHELL32\SHGetSetFolderCustomSettings"
    , "Ptr", pfcs   ; SHFOLDERCUSTOMSETTINGS* in/out
    , "WStr", pszPath   ; LPCWSTR
    , "UInt", dwReadWrite   ; DWORD
    , "Int")   ; return: HRESULT
●SHGetSetFolderCustomSettings(pfcs, pszPath, dwReadWrite) = DLL("SHELL32.dll", "int SHGetSetFolderCustomSettings(void*, char*, dword)")
# 呼び出し: SHGetSetFolderCustomSettings(pfcs, pszPath, dwReadWrite)
# pfcs : SHFOLDERCUSTOMSETTINGS* in/out -> "void*"
# pszPath : LPCWSTR -> "char*"
# dwReadWrite : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shell32" fn SHGetSetFolderCustomSettings(
    pfcs: [*c]SHFOLDERCUSTOMSETTINGS, // SHFOLDERCUSTOMSETTINGS* in/out
    pszPath: [*c]const u16, // LPCWSTR
    dwReadWrite: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc SHGetSetFolderCustomSettings(
    pfcs: ptr SHFOLDERCUSTOMSETTINGS,  # SHFOLDERCUSTOMSETTINGS* in/out
    pszPath: WideCString,  # LPCWSTR
    dwReadWrite: uint32  # DWORD
): int32 {.importc: "SHGetSetFolderCustomSettings", stdcall, dynlib: "SHELL32.dll".}
pragma(lib, "shell32");
extern(Windows)
int SHGetSetFolderCustomSettings(
    SHFOLDERCUSTOMSETTINGS* pfcs,   // SHFOLDERCUSTOMSETTINGS* in/out
    const(wchar)* pszPath,   // LPCWSTR
    uint dwReadWrite   // DWORD
);
ccall((:SHGetSetFolderCustomSettings, "SHELL32.dll"), stdcall, Int32,
      (Ptr{SHFOLDERCUSTOMSETTINGS}, Cwstring, UInt32),
      pfcs, pszPath, dwReadWrite)
# pfcs : SHFOLDERCUSTOMSETTINGS* in/out -> Ptr{SHFOLDERCUSTOMSETTINGS}
# pszPath : LPCWSTR -> Cwstring
# dwReadWrite : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SHGetSetFolderCustomSettings(
    void* pfcs,
    const uint16_t* pszPath,
    uint32_t dwReadWrite);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHGetSetFolderCustomSettings(pfcs, pszPath, dwReadWrite)
-- pfcs : SHFOLDERCUSTOMSETTINGS* in/out
-- pszPath : LPCWSTR
-- dwReadWrite : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHGetSetFolderCustomSettings = lib.func('__stdcall', 'SHGetSetFolderCustomSettings', 'int32_t', ['void *', 'str16', 'uint32_t']);
// SHGetSetFolderCustomSettings(pfcs, pszPath, dwReadWrite)
// pfcs : SHFOLDERCUSTOMSETTINGS* in/out -> 'void *'
// pszPath : LPCWSTR -> 'str16'
// dwReadWrite : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  SHGetSetFolderCustomSettings: { parameters: ["pointer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.SHGetSetFolderCustomSettings(pfcs, pszPath, dwReadWrite)
// pfcs : SHFOLDERCUSTOMSETTINGS* in/out -> "pointer"
// pszPath : LPCWSTR -> "buffer"
// dwReadWrite : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SHGetSetFolderCustomSettings(
    void* pfcs,
    const uint16_t* pszPath,
    uint32_t dwReadWrite);
C, "SHELL32.dll");
// $ffi->SHGetSetFolderCustomSettings(pfcs, pszPath, dwReadWrite);
// pfcs : SHFOLDERCUSTOMSETTINGS* in/out
// pszPath : LPCWSTR
// dwReadWrite : DWORD
// 構造体/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 Shell32 extends StdCallLibrary {
    Shell32 INSTANCE = Native.load("shell32", Shell32.class);
    int SHGetSetFolderCustomSettings(
        Pointer pfcs,   // SHFOLDERCUSTOMSETTINGS* in/out
        WString pszPath,   // LPCWSTR
        int dwReadWrite   // DWORD
    );
}
@[Link("shell32")]
lib LibSHELL32
  fun SHGetSetFolderCustomSettings = SHGetSetFolderCustomSettings(
    pfcs : SHFOLDERCUSTOMSETTINGS*,   # SHFOLDERCUSTOMSETTINGS* in/out
    pszPath : UInt16*,   # LPCWSTR
    dwReadWrite : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHGetSetFolderCustomSettingsNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Uint32);
typedef SHGetSetFolderCustomSettingsDart = int Function(Pointer<Void>, Pointer<Utf16>, int);
final SHGetSetFolderCustomSettings = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHGetSetFolderCustomSettingsNative, SHGetSetFolderCustomSettingsDart>('SHGetSetFolderCustomSettings');
// pfcs : SHFOLDERCUSTOMSETTINGS* in/out -> Pointer<Void>
// pszPath : LPCWSTR -> Pointer<Utf16>
// dwReadWrite : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHGetSetFolderCustomSettings(
  pfcs: Pointer;   // SHFOLDERCUSTOMSETTINGS* in/out
  pszPath: PWideChar;   // LPCWSTR
  dwReadWrite: DWORD   // DWORD
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHGetSetFolderCustomSettings';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHGetSetFolderCustomSettings"
  c_SHGetSetFolderCustomSettings :: Ptr () -> CWString -> Word32 -> IO Int32
-- pfcs : SHFOLDERCUSTOMSETTINGS* in/out -> Ptr ()
-- pszPath : LPCWSTR -> CWString
-- dwReadWrite : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shgetsetfoldercustomsettings =
  foreign "SHGetSetFolderCustomSettings"
    ((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* pfcs : SHFOLDERCUSTOMSETTINGS* in/out -> (ptr void) *)
(* pszPath : LPCWSTR -> (ptr uint16_t) *)
(* dwReadWrite : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHGetSetFolderCustomSettings" shget-set-folder-custom-settings :convention :stdcall) :int32
  (pfcs :pointer)   ; SHFOLDERCUSTOMSETTINGS* in/out
  (psz-path (:string :encoding :utf-16le))   ; LPCWSTR
  (dw-read-write :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHGetSetFolderCustomSettings = Win32::API::More->new('SHELL32',
    'int SHGetSetFolderCustomSettings(LPVOID pfcs, LPCWSTR pszPath, DWORD dwReadWrite)');
# my $ret = $SHGetSetFolderCustomSettings->Call($pfcs, $pszPath, $dwReadWrite);
# pfcs : SHFOLDERCUSTOMSETTINGS* in/out -> LPVOID
# pszPath : LPCWSTR -> LPCWSTR
# dwReadWrite : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型