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

SHSetFolderPathA

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

シグネチャ

// SHELL32.dll  (ANSI / -A)
#include <windows.h>

HRESULT SHSetFolderPathA(
    INT csidl,
    HANDLE hToken,   // optional
    DWORD dwFlags,
    LPCSTR pszPath
);

パラメーター

名前方向説明
csidlINTin

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

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

hTokenHANDLEinoptional

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

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

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

戻り値の型: HRESULT

公式ドキュメント

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

戻り値

型: 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 を定義しています。エンコーディング中立なエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイル エラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規約を参照してください。

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

各言語での呼び出し定義

// SHELL32.dll  (ANSI / -A)
#include <windows.h>

HRESULT SHSetFolderPathA(
    INT csidl,
    HANDLE hToken,   // optional
    DWORD dwFlags,
    LPCSTR pszPath
);
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int SHSetFolderPathA(
    int csidl,   // INT
    IntPtr hToken,   // HANDLE optional
    uint dwFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string pszPath   // LPCSTR
);
<DllImport("SHELL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHSetFolderPathA(
    csidl As Integer,   ' INT
    hToken As IntPtr,   ' HANDLE optional
    dwFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> pszPath As String   ' LPCSTR
) As Integer
End Function
' csidl : INT
' hToken : HANDLE optional
' dwFlags : DWORD
' pszPath : LPCSTR
Declare PtrSafe Function SHSetFolderPathA Lib "shell32" ( _
    ByVal csidl As Long, _
    ByVal hToken As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pszPath As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHSetFolderPathA = shell32.NewProc("SHSetFolderPathA")
)

// csidl (INT), hToken (HANDLE optional), dwFlags (DWORD), pszPath (LPCSTR)
r1, _, err := procSHSetFolderPathA.Call(
	uintptr(csidl),
	uintptr(hToken),
	uintptr(dwFlags),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszPath))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function SHSetFolderPathA(
  csidl: Integer;   // INT
  hToken: THandle;   // HANDLE optional
  dwFlags: DWORD;   // DWORD
  pszPath: PAnsiChar   // LPCSTR
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHSetFolderPathA';
result := DllCall("SHELL32\SHSetFolderPathA"
    , "Int", csidl   ; INT
    , "Ptr", hToken   ; HANDLE optional
    , "UInt", dwFlags   ; DWORD
    , "AStr", pszPath   ; LPCSTR
    , "Int")   ; return: HRESULT
●SHSetFolderPathA(csidl, hToken, dwFlags, pszPath) = DLL("SHELL32.dll", "int SHSetFolderPathA(int, void*, dword, char*)")
# 呼び出し: SHSetFolderPathA(csidl, hToken, dwFlags, pszPath)
# csidl : INT -> "int"
# hToken : HANDLE optional -> "void*"
# dwFlags : DWORD -> "dword"
# pszPath : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

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

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

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

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

関連項目

文字セット違い