ホーム › UI.Shell › SHSetKnownFolderPath

SHSetKnownFolderPath

関数

KNOWNFOLDERIDで指定した既知フォルダーのパスを設定する。

DLLSHELL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT SHSetKnownFolderPath(
    const GUID* rfid,
    DWORD dwFlags,
    HANDLE hToken,   // optional
    LPCWSTR pszPath
);

パラメーター

名前	型	方向	説明
rfid	GUID*	in	既知のフォルダーを識別する GUID です。
dwFlags	DWORD	in	0 または次の値のいずれかです。 KF_FLAG_DONT_UNEXPAND このフラグが設定されている場合、pszPath が参照するパスの一部が `%USERPROFILE%` などの環境文字列で表される場合があります。
hToken	HANDLE	inoptional	特定のユーザーを表すために使用されるアクセストークンです。このパラメーターは通常 NULL に設定され、その場合、関数は現在のユーザーのフォルダーインスタンスへのアクセスを試みます。ただし、複数のユーザーを持つことができるが単一のユーザーに属するものとして扱われるフォルダーについては、hToken に値を割り当てる必要がある場合があります。この種類で最もよく使用されるフォルダーは Documents です。 hToken が非 NULL の場合、呼び出し側アプリケーションは正しい偽装を行う責任があります。アプリケーションは、TOKEN_QUERY および TOKEN_IMPERSONATE を含む、その特定のユーザーに対する適切なセキュリティ特権を持っている必要があり、そのユーザーのレジストリハイブが現在マウントされている必要があります。アクセス制御に関する問題の詳細については、Access Control を参照してください。 hToken パラメーターに値 -1 を割り当てると、既定のユーザー (Default User) を示します。これにより、SHSetKnownFolderPath のクライアントは、既定のユーザーに対してフォルダーの場所 (Desktop フォルダーなど) を設定できます。既定のユーザーのユーザープロファイルは、新しいユーザーアカウントが作成されるときに複製され、Documents や Desktop などの特殊フォルダーを含みます。既定のユーザーフォルダーに追加された項目は、新しいユーザーアカウントにも表示されます。なお、既定のユーザーフォルダーへのアクセスには管理者特権が必要です。
pszPath	LPCWSTR	in	フォルダーの新しいパスへのポインターです。これは長さ MAX_PATH の null 終端 Unicode 文字列です。このパスの長さを 0 にすることはできません。

戻り値の型: HRESULT

公式ドキュメント

既知のフォルダーを新しい場所にリダイレクトします。

戻り値

型: HRESULT

成功した場合は S_OK を返し、それ以外の場合は次を含むエラー値を返します。

戻り値	説明
E_INVALIDARG	この値は、特に rfid パラメーターがシステムに存在しない KNOWNFOLDERID を参照していることを示す場合があります。すべての KNOWNFOLDERID 値がすべてのシステムに存在するわけではありません。現在のシステムの KNOWNFOLDERID 値のセットを取得するには、IKnownFolderManager::GetFolderIds を使用してください。

戻り値

説明

E_INVALIDARG

この値は、特に rfid パラメーターがシステムに存在しない KNOWNFOLDERID を参照していることを示す場合があります。すべての KNOWNFOLDERID 値がすべてのシステムに存在するわけではありません。現在のシステムの KNOWNFOLDERID 値のセットを取得するには、IKnownFolderManager::GetFolderIds を使用してください。

解説(Remarks)

この関数は SHSetFolderPath を置き換えます。その古い関数は、現在は単に SHSetKnownFolderPath のラッパーになっています。

この関数の呼び出し側は管理者特権を持っている必要があります。パブリックな既知のフォルダーに対してこの関数を呼び出すには、呼び出し側は管理者特権を持っている必要があります。ユーザーごとの既知のフォルダーの場合、呼び出し側にはユーザー特権のみが必要です。

一部の既知のフォルダー (たとえば Documents フォルダー) はユーザーごとに固有です。各ユーザーは Documents フォルダーに対して異なるパスを持ちます。hToken が NULL の場合、API は呼び出し側アプリケーションのフォルダーインスタンス (つまり現在のユーザーのもの) へのアクセスを試みます。hToken が有効なユーザートークンである場合、API はそのトークンを使用してユーザーを偽装し、そのユーザーのインスタンスへのアクセスを試みます。

この関数は、KF_CATEGORY_FIXED および KF_CATEGORY_VIRTUAL 型のフォルダーに対しては呼び出すことができません。

KF_CATEGORY_COMMON 型のフォルダーに対してこの関数を呼び出すには、呼び出し側アプリケーションが昇格された特権で実行されている必要があります。

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

各言語での呼び出し定義

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

HRESULT SHSetKnownFolderPath(
    const GUID* rfid,
    DWORD dwFlags,
    HANDLE hToken,   // optional
    LPCWSTR pszPath
);

[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHSetKnownFolderPath(
    ref Guid rfid,   // GUID*
    uint dwFlags,   // DWORD
    IntPtr hToken,   // HANDLE optional
    [MarshalAs(UnmanagedType.LPWStr)] string pszPath   // LPCWSTR
);

<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHSetKnownFolderPath(
    ByRef rfid As Guid,   ' GUID*
    dwFlags As UInteger,   ' DWORD
    hToken As IntPtr,   ' HANDLE optional
    <MarshalAs(UnmanagedType.LPWStr)> pszPath As String   ' LPCWSTR
) As Integer
End Function

' rfid : GUID*
' dwFlags : DWORD
' hToken : HANDLE optional
' pszPath : LPCWSTR
Declare PtrSafe Function SHSetKnownFolderPath Lib "shell32" ( _
    ByVal rfid As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal hToken As LongPtr, _
    ByVal pszPath As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHSetKnownFolderPath = ctypes.windll.shell32.SHSetKnownFolderPath
SHSetKnownFolderPath.restype = ctypes.c_int
SHSetKnownFolderPath.argtypes = [
    ctypes.c_void_p,  # rfid : GUID*
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.HANDLE,  # hToken : HANDLE optional
    wintypes.LPCWSTR,  # pszPath : LPCWSTR
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHSetKnownFolderPath = Fiddle::Function.new(
  lib['SHSetKnownFolderPath'],
  [
    Fiddle::TYPE_VOIDP,  # rfid : GUID*
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # hToken : HANDLE optional
    Fiddle::TYPE_VOIDP,  # pszPath : LPCWSTR
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn SHSetKnownFolderPath(
        rfid: *const GUID,  // GUID*
        dwFlags: u32,  // DWORD
        hToken: *mut core::ffi::c_void,  // HANDLE optional
        pszPath: *const u16  // LPCWSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll")]
public static extern int SHSetKnownFolderPath(ref Guid rfid, uint dwFlags, IntPtr hToken, [MarshalAs(UnmanagedType.LPWStr)] string pszPath);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHSetKnownFolderPath' -Namespace Win32 -PassThru
# $api::SHSetKnownFolderPath(rfid, dwFlags, hToken, pszPath)

#uselib "SHELL32.dll"
#func global SHSetKnownFolderPath "SHSetKnownFolderPath" sptr, sptr, sptr, sptr
; SHSetKnownFolderPath varptr(rfid), dwFlags, hToken, pszPath   ; 戻り値は stat
; rfid : GUID* -> "sptr"
; dwFlags : DWORD -> "sptr"
; hToken : HANDLE optional -> "sptr"
; pszPath : LPCWSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHELL32.dll"
#cfunc global SHSetKnownFolderPath "SHSetKnownFolderPath" var, int, sptr, wstr
; res = SHSetKnownFolderPath(rfid, dwFlags, hToken, pszPath)
; rfid : GUID* -> "var"
; dwFlags : DWORD -> "int"
; hToken : HANDLE optional -> "sptr"
; pszPath : LPCWSTR -> "wstr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll"
#cfunc global SHSetKnownFolderPath "SHSetKnownFolderPath" sptr, int, sptr, wstr
; res = SHSetKnownFolderPath(varptr(rfid), dwFlags, hToken, pszPath)
; rfid : GUID* -> "sptr"
; dwFlags : DWORD -> "int"
; hToken : HANDLE optional -> "sptr"
; pszPath : LPCWSTR -> "wstr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。