ホーム › UI.Shell › SHGetKnownFolderPath

SHGetKnownFolderPath

関数

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

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

シグネチャ

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

HRESULT SHGetKnownFolderPath(
    const GUID* rfid,
    DWORD dwFlags,
    HANDLE hToken,   // optional
    LPWSTR* ppszPath
);

パラメーター

名前	型	方向	説明
rfid	GUID*	in	フォルダーを識別する KNOWNFOLDERID への参照です。
dwFlags	DWORD	in	特別な取得オプションを指定するフラグです。この値は 0 にすることができます。それ以外の場合は、1 つ以上の KNOWN_FOLDER_FLAG の値を指定します。
hToken	HANDLE	inoptional	特定のユーザーを表すアクセストークンです。このパラメーターが NULL の場合(最も一般的な使用方法)、関数は現在のユーザーの既知のフォルダーを要求します。特定のユーザーのフォルダーを要求するには、そのユーザーの hToken を渡します。これは通常、指定されたユーザーのトークンを取得するのに十分な権限を持つサービスのコンテキストで行われます。そのトークンは、TOKEN_QUERY および TOKEN_IMPERSONATE の権限で開く必要があります。場合によっては、TOKEN_DUPLICATE を含める必要もあります。ユーザーの hToken を渡すことに加えて、その特定のユーザーのレジストリハイブをマウントしておく必要があります。アクセス制御に関する問題の詳細については、Access Control を参照してください。 hToken パラメーターに -1 の値を割り当てると、既定のユーザー(Default User)を示します。これにより、SHGetKnownFolderPath のクライアントは、既定のユーザーに対する(Desktop フォルダーなどの)フォルダーの場所を見つけることができます。既定のユーザーのユーザープロファイルは、新しいユーザーアカウントが作成されるたびに複製され、Documents や Desktop などの特別なフォルダーが含まれます。既定のユーザーフォルダーに追加された項目は、新しいユーザーアカウントにも表示されます。なお、既定のユーザーフォルダーへのアクセスには管理者権限が必要です。
ppszPath	LPWSTR*	out	このメソッドが返るとき、既知のフォルダーのパスを指定する null 終端 Unicode 文字列へのポインターのアドレスが格納されます。SHGetKnownFolderPath が成功したかどうかにかかわらず、このリソースが不要になった時点で CoTaskMemFree を呼び出して解放する責任は、呼び出し元のプロセスにあります。返されるパスには末尾の円記号(バックスラッシュ)は含まれません。たとえば、"C:\Users\" ではなく "C:\Users" が返されます。

戻り値の型: HRESULT

公式ドキュメント

フォルダーの KNOWNFOLDERID によって識別される既知のフォルダーの完全なパスを取得します。

戻り値

型: HRESULT

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

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

戻り値

説明

E_FAIL

この値は、特に、rfid パラメーターがパスを持たない KNOWNFOLDERID(KF_CATEGORY_VIRTUAL としてマークされたフォルダーなど)を参照していることを示している場合があります。

E_INVALIDARG

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

解説(Remarks)

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

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

各言語での呼び出し定義

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

HRESULT SHGetKnownFolderPath(
    const GUID* rfid,
    DWORD dwFlags,
    HANDLE hToken,   // optional
    LPWSTR* ppszPath
);

[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHGetKnownFolderPath(
    ref Guid rfid,   // GUID*
    uint dwFlags,   // DWORD
    IntPtr hToken,   // HANDLE optional
    IntPtr ppszPath   // LPWSTR* out
);

<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHGetKnownFolderPath(
    ByRef rfid As Guid,   ' GUID*
    dwFlags As UInteger,   ' DWORD
    hToken As IntPtr,   ' HANDLE optional
    ppszPath As IntPtr   ' LPWSTR* out
) As Integer
End Function

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

import ctypes
from ctypes import wintypes

SHGetKnownFolderPath = ctypes.windll.shell32.SHGetKnownFolderPath
SHGetKnownFolderPath.restype = ctypes.c_int
SHGetKnownFolderPath.argtypes = [
    ctypes.c_void_p,  # rfid : GUID*
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.HANDLE,  # hToken : HANDLE optional
    ctypes.c_void_p,  # ppszPath : LPWSTR* out
]

require 'fiddle'
require 'fiddle/import'

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

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

$sig = @"
[DllImport("SHELL32.dll")]
public static extern int SHGetKnownFolderPath(ref Guid rfid, uint dwFlags, IntPtr hToken, IntPtr ppszPath);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHGetKnownFolderPath' -Namespace Win32 -PassThru
# $api::SHGetKnownFolderPath(rfid, dwFlags, hToken, ppszPath)

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

出力引数:

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