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

SHSetFolderPathW

関数
CSIDLで指定したフォルダーのパス(Unicode)を設定する。
DLLSHELL32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT SHSetFolderPathW(
    INT csidl,
    HANDLE hToken,   // optional
    DWORD dwFlags,
    LPCWSTR pszPath
);

パラメーター

名前方向説明
csidlINTin

パスを設定するフォルダーを識別する CSIDL 値です。物理フォルダーのみが有効です。仮想フォルダーを指定すると、この関数は失敗します。

文字列がレジストリに指定どおり正確に書き込まれるようにするには、CSIDL に CSIDL_FLAG_DONT_UNEXPAND 値を追加します。CSIDL_FLAG_DONT_UNEXPAND フラグを含めない場合、パスの一部が %USERPROFILE% などの環境文字列に置き換えられることがあります。

hTokenHANDLEinoptional

特定のユーザーを表すために使用できる アクセストークンです。このパラメーターは通常 NULL に設定され、その場合、関数は現在のユーザーのフォルダーインスタンスへのアクセスを試みます。ただし、複数のユーザーを持ちうるが単一のユーザーに属するものとして扱われるフォルダーについては、hToken に値を割り当てる必要がある場合があります。このタイプで最もよく使用されるフォルダーは Documents です。

hToken が非 NULL の場合、正しい偽装を行うのは呼び出し元アプリケーションの責任です。アプリケーションは、TOKEN_QUERY および TOKEN_IMPERSONATE を含む、対象ユーザーに対する適切なセキュリティ特権を保有している必要があり、かつそのユーザーのレジストリハイブが現在マウントされている必要があります。アクセス制御に関する詳細は、Access Control を参照してください。

dwFlagsDWORDin予約されています。0 を設定する必要があります。
pszPathLPCWSTRinフォルダーの新しいパスを含む、長さ MAX_PATH の null 終端文字列へのポインターです。この値を NULL にすることはできず、文字列の長さを 0 にすることもできません。

戻り値の型: HRESULT

公式ドキュメント

非推奨。CSIDL で識別されるシステムフォルダーに新しいパスを割り当てます。(Unicode)

戻り値

型: HRESULT

以下を含む標準の HRESULT コードを返します。

戻り値 説明
S_OK
フォルダーのパスが正常に更新されました。
E_INVALIDARG
この値は、次を含むいくつかのエラー条件によって返されます。
  • csidl 値が無効です。
  • csidl 値が仮想フォルダーを参照していません。
  • csidl 値がシステムフォルダーを参照していません。
  • csidl 値が、名前変更または移動できないフォルダーを参照しています。
  • dwFlags 値が 0 ではありません。
  • pszPath 値が NULL です。
  • pszPath 値が指す文字列が、長さ 0 の空文字列("")です。

解説(Remarks)

注意 Windows Vista 以降、この関数は単なる SHSetKnownFolderPath のラッパーです。CSIDL 値は対応する KNOWNFOLDERID に変換され、SHSetKnownFolderPath が呼び出されます。新しいアプリケーションでは、後方互換性のためにのみサポートされている古い CSIDL システムではなく、Known Folder システムを使用してください。
SHSetFolderPath は Shell32.dll から名前ではエクスポートされません。この関数を使用するには、関数ポインターを取得するために、SHSetFolderPathA(ANSI 文字列の場合)では序数 231、SHSetFolderPathW(Unicode 文字列の場合)では序数 232 を指定して GetProcAddress を呼び出す必要があります。

フォルダー名には ANSI で表現できない Unicode 文字が含まれる場合があるため、パスは Unicode 文字列として表現することをお勧めします。

メモ

shlobj_core.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SHSetFolderPath を定義しています。エンコーディング中立なエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、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 SHSetFolderPathW(
    INT csidl,
    HANDLE hToken,   // optional
    DWORD dwFlags,
    LPCWSTR pszPath
);
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SHSetFolderPathW(
    int csidl,   // INT
    IntPtr hToken,   // HANDLE optional
    uint dwFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string pszPath   // LPCWSTR
);
<DllImport("SHELL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHSetFolderPathW(
    csidl As Integer,   ' INT
    hToken As IntPtr,   ' HANDLE optional
    dwFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> pszPath As String   ' LPCWSTR
) As Integer
End Function
' csidl : INT
' hToken : HANDLE optional
' dwFlags : DWORD
' pszPath : LPCWSTR
Declare PtrSafe Function SHSetFolderPathW Lib "shell32" ( _
    ByVal csidl As Long, _
    ByVal hToken As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pszPath 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

SHSetFolderPathW = ctypes.windll.shell32.SHSetFolderPathW
SHSetFolderPathW.restype = ctypes.c_int
SHSetFolderPathW.argtypes = [
    ctypes.c_int,  # csidl : INT
    wintypes.HANDLE,  # hToken : HANDLE optional
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.LPCWSTR,  # pszPath : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHSetFolderPathW = Fiddle::Function.new(
  lib['SHSetFolderPathW'],
  [
    Fiddle::TYPE_INT,  # csidl : INT
    Fiddle::TYPE_VOIDP,  # hToken : HANDLE optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pszPath : LPCWSTR
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shell32")]
extern "system" {
    fn SHSetFolderPathW(
        csidl: i32,  // INT
        hToken: *mut core::ffi::c_void,  // HANDLE optional
        dwFlags: u32,  // DWORD
        pszPath: *const u16  // LPCWSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode)]
public static extern int SHSetFolderPathW(int csidl, IntPtr hToken, uint dwFlags, [MarshalAs(UnmanagedType.LPWStr)] string pszPath);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHSetFolderPathW' -Namespace Win32 -PassThru
# $api::SHSetFolderPathW(csidl, hToken, dwFlags, pszPath)
#uselib "SHELL32.dll"
#func global SHSetFolderPathW "SHSetFolderPathW" wptr, wptr, wptr, wptr
; SHSetFolderPathW csidl, hToken, dwFlags, pszPath   ; 戻り値は stat
; csidl : INT -> "wptr"
; hToken : HANDLE optional -> "wptr"
; dwFlags : DWORD -> "wptr"
; pszPath : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHELL32.dll"
#cfunc global SHSetFolderPathW "SHSetFolderPathW" int, sptr, int, wstr
; res = SHSetFolderPathW(csidl, hToken, dwFlags, pszPath)
; csidl : INT -> "int"
; hToken : HANDLE optional -> "sptr"
; dwFlags : DWORD -> "int"
; pszPath : LPCWSTR -> "wstr"
; HRESULT SHSetFolderPathW(INT csidl, HANDLE hToken, DWORD dwFlags, LPCWSTR pszPath)
#uselib "SHELL32.dll"
#cfunc global SHSetFolderPathW "SHSetFolderPathW" int, intptr, int, wstr
; res = SHSetFolderPathW(csidl, hToken, dwFlags, pszPath)
; csidl : INT -> "int"
; hToken : HANDLE optional -> "intptr"
; dwFlags : DWORD -> "int"
; pszPath : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHSetFolderPathW = shell32.NewProc("SHSetFolderPathW")
)

// csidl (INT), hToken (HANDLE optional), dwFlags (DWORD), pszPath (LPCWSTR)
r1, _, err := procSHSetFolderPathW.Call(
	uintptr(csidl),
	uintptr(hToken),
	uintptr(dwFlags),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszPath))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function SHSetFolderPathW(
  csidl: Integer;   // INT
  hToken: THandle;   // HANDLE optional
  dwFlags: DWORD;   // DWORD
  pszPath: PWideChar   // LPCWSTR
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHSetFolderPathW';
result := DllCall("SHELL32\SHSetFolderPathW"
    , "Int", csidl   ; INT
    , "Ptr", hToken   ; HANDLE optional
    , "UInt", dwFlags   ; DWORD
    , "WStr", pszPath   ; LPCWSTR
    , "Int")   ; return: HRESULT
●SHSetFolderPathW(csidl, hToken, dwFlags, pszPath) = DLL("SHELL32.dll", "int SHSetFolderPathW(int, void*, dword, char*)")
# 呼び出し: SHSetFolderPathW(csidl, hToken, dwFlags, pszPath)
# csidl : INT -> "int"
# hToken : HANDLE optional -> "void*"
# dwFlags : DWORD -> "dword"
# pszPath : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "shell32" fn SHSetFolderPathW(
    csidl: i32, // INT
    hToken: ?*anyopaque, // HANDLE optional
    dwFlags: u32, // DWORD
    pszPath: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SHSetFolderPathW(
    csidl: int32,  # INT
    hToken: pointer,  # HANDLE optional
    dwFlags: uint32,  # DWORD
    pszPath: WideCString  # LPCWSTR
): int32 {.importc: "SHSetFolderPathW", stdcall, dynlib: "SHELL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shell32");
extern(Windows)
int SHSetFolderPathW(
    int csidl,   // INT
    void* hToken,   // HANDLE optional
    uint dwFlags,   // DWORD
    const(wchar)* pszPath   // LPCWSTR
);
ccall((:SHSetFolderPathW, "SHELL32.dll"), stdcall, Int32,
      (Int32, Ptr{Cvoid}, UInt32, Cwstring),
      csidl, hToken, dwFlags, pszPath)
# csidl : INT -> Int32
# hToken : HANDLE optional -> Ptr{Cvoid}
# dwFlags : DWORD -> UInt32
# pszPath : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SHSetFolderPathW(
    int32_t csidl,
    void* hToken,
    uint32_t dwFlags,
    const uint16_t* pszPath);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHSetFolderPathW(csidl, hToken, dwFlags, pszPath)
-- csidl : INT
-- hToken : HANDLE optional
-- dwFlags : DWORD
-- pszPath : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHSetFolderPathW = lib.func('__stdcall', 'SHSetFolderPathW', 'int32_t', ['int32_t', 'void *', 'uint32_t', 'str16']);
// SHSetFolderPathW(csidl, hToken, dwFlags, pszPath)
// csidl : INT -> 'int32_t'
// hToken : HANDLE optional -> 'void *'
// dwFlags : DWORD -> 'uint32_t'
// pszPath : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  SHSetFolderPathW: { parameters: ["i32", "pointer", "u32", "buffer"], result: "i32" },
});
// lib.symbols.SHSetFolderPathW(csidl, hToken, dwFlags, pszPath)
// csidl : INT -> "i32"
// hToken : HANDLE optional -> "pointer"
// dwFlags : DWORD -> "u32"
// pszPath : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SHSetFolderPathW(
    int32_t csidl,
    void* hToken,
    uint32_t dwFlags,
    const uint16_t* pszPath);
C, "SHELL32.dll");
// $ffi->SHSetFolderPathW(csidl, hToken, dwFlags, pszPath);
// csidl : INT
// hToken : HANDLE optional
// dwFlags : DWORD
// pszPath : LPCWSTR
// 構造体/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, W32APIOptions.UNICODE_OPTIONS);
    int SHSetFolderPathW(
        int csidl,   // INT
        Pointer hToken,   // HANDLE optional
        int dwFlags,   // DWORD
        WString pszPath   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shell32")]
lib LibSHELL32
  fun SHSetFolderPathW = SHSetFolderPathW(
    csidl : Int32,   # INT
    hToken : Void*,   # HANDLE optional
    dwFlags : UInt32,   # DWORD
    pszPath : UInt16*   # LPCWSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHSetFolderPathWNative = Int32 Function(Int32, Pointer<Void>, Uint32, Pointer<Utf16>);
typedef SHSetFolderPathWDart = int Function(int, Pointer<Void>, int, Pointer<Utf16>);
final SHSetFolderPathW = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHSetFolderPathWNative, SHSetFolderPathWDart>('SHSetFolderPathW');
// csidl : INT -> Int32
// hToken : HANDLE optional -> Pointer<Void>
// dwFlags : DWORD -> Uint32
// pszPath : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHSetFolderPathW(
  csidl: Integer;   // INT
  hToken: THandle;   // HANDLE optional
  dwFlags: DWORD;   // DWORD
  pszPath: PWideChar   // LPCWSTR
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHSetFolderPathW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHSetFolderPathW"
  c_SHSetFolderPathW :: Int32 -> Ptr () -> Word32 -> CWString -> IO Int32
-- csidl : INT -> Int32
-- hToken : HANDLE optional -> Ptr ()
-- dwFlags : DWORD -> Word32
-- pszPath : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shsetfolderpathw =
  foreign "SHSetFolderPathW"
    (int32_t @-> (ptr void) @-> uint32_t @-> (ptr uint16_t) @-> returning int32_t)
(* csidl : INT -> int32_t *)
(* hToken : HANDLE optional -> (ptr void) *)
(* dwFlags : DWORD -> uint32_t *)
(* pszPath : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHSetFolderPathW" shset-folder-path-w :convention :stdcall) :int32
  (csidl :int32)   ; INT
  (h-token :pointer)   ; HANDLE optional
  (dw-flags :uint32)   ; DWORD
  (psz-path (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHSetFolderPathW = Win32::API::More->new('SHELL32',
    'int SHSetFolderPathW(int csidl, HANDLE hToken, DWORD dwFlags, LPCWSTR pszPath)');
# my $ret = $SHSetFolderPathW->Call($csidl, $hToken, $dwFlags, $pszPath);
# csidl : INT -> int
# hToken : HANDLE optional -> HANDLE
# dwFlags : DWORD -> DWORD
# pszPath : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い