ホーム › UI.Shell › SHGetFolderPathAndSubDirA

SHGetFolderPathAndSubDirA

関数

特殊フォルダー配下のサブディレクトリパス(ANSI)を取得し作成する。

DLLSHELL32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT SHGetFolderPathAndSubDirA(
    HWND hwnd,   // optional
    INT csidl,
    HANDLE hToken,   // optional
    DWORD dwFlags,
    LPCSTR pszSubDir,   // optional
    LPSTR pszPath
);

パラメーター

名前	型	方向	説明
hwnd	HWND	optional	予約済みです。
csidl	INT	in	パスを取得するフォルダーを識別する CSIDL 値です。実在するフォルダーのみが有効です。仮想フォルダーを指定した場合、この関数は失敗します。フォルダーの CSIDL を CSIDL_FLAG_CREATE と組み合わせることで、SHGetFolderPathAndSubDir によるフォルダーの作成を強制できます。
hToken	HANDLE	inoptional	特定のユーザーを表すアクセストークンです。Windows 2000 より前のシステムでは、この値を NULL に設定します。それ以降のシステムでは、hToken は通常 NULL に設定されますが、常にそうとは限りません。複数のユーザーを持ちながら単一のユーザーに属するものとして扱われるフォルダーに対しては、hToken に値を割り当てる必要がある場合があります。この種のフォルダーで最もよく使われるのは My Documents です。
dwFlags	DWORD	in	返されるパスがフォルダーの実際のパスか既定のパスかを指定します。この値は、CSIDL 値に関連付けられたフォルダーがユーザーによって移動または名前変更される可能性がある場合に使用されます。 SHGFP_TYPE_CURRENT フォルダーの現在のパスを返します。 SHGFP_TYPE_DEFAULT フォルダーの既定のパスを返します。
pszSubDir	LPCSTR	inoptional	フォルダーのパスに追加するサブパスへのポインターです。これは長さ MAX_PATH の null 終端文字列です。新しいディレクトリを作成しない場合、これは既存のサブディレクトリでなければならず、そうでなければ関数はエラーを返します。サブパスを追加しない場合、この値は NULL にできます。
pszPath	LPSTR	out	この関数が返るとき、この値はディレクトリのパスと追加されたサブパスを指します。これは長さ MAX_PATH の null 終端文字列です。関数がエラーコードを返すとき、この文字列は空になります。

戻り値の型: HRESULT

公式ドキュメント

フォルダーのパスを取得し、ユーザーが指定したサブフォルダーのパスを追加します。(ANSI)

戻り値

型: HRESULT

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

解説(Remarks)

メモ

shlobj_core.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SHGetFolderPathAndSubDir を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致につながる可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SHGetFolderPathAndSubDirA(
    HWND hwnd,   // optional
    INT csidl,
    HANDLE hToken,   // optional
    DWORD dwFlags,
    LPCSTR pszSubDir,   // optional
    LPSTR pszPath
);

[DllImport("SHELL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int SHGetFolderPathAndSubDirA(
    IntPtr hwnd,   // HWND optional
    int csidl,   // INT
    IntPtr hToken,   // HANDLE optional
    uint dwFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string pszSubDir,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszPath   // LPSTR out
);

<DllImport("SHELL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHGetFolderPathAndSubDirA(
    hwnd As IntPtr,   ' HWND optional
    csidl As Integer,   ' INT
    hToken As IntPtr,   ' HANDLE optional
    dwFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> pszSubDir As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> pszPath As System.Text.StringBuilder   ' LPSTR out
) As Integer
End Function

' hwnd : HWND optional
' csidl : INT
' hToken : HANDLE optional
' dwFlags : DWORD
' pszSubDir : LPCSTR optional
' pszPath : LPSTR out
Declare PtrSafe Function SHGetFolderPathAndSubDirA Lib "shell32" ( _
    ByVal hwnd As LongPtr, _
    ByVal csidl As Long, _
    ByVal hToken As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pszSubDir As String, _
    ByVal pszPath As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHGetFolderPathAndSubDirA = ctypes.windll.shell32.SHGetFolderPathAndSubDirA
SHGetFolderPathAndSubDirA.restype = ctypes.c_int
SHGetFolderPathAndSubDirA.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND optional
    ctypes.c_int,  # csidl : INT
    wintypes.HANDLE,  # hToken : HANDLE optional
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.LPCSTR,  # pszSubDir : LPCSTR optional
    wintypes.LPSTR,  # pszPath : LPSTR out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHGetFolderPathAndSubDirA = Fiddle::Function.new(
  lib['SHGetFolderPathAndSubDirA'],
  [
    Fiddle::TYPE_VOIDP,  # hwnd : HWND optional
    Fiddle::TYPE_INT,  # csidl : INT
    Fiddle::TYPE_VOIDP,  # hToken : HANDLE optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pszSubDir : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # pszPath : LPSTR out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn SHGetFolderPathAndSubDirA(
        hwnd: *mut core::ffi::c_void,  // HWND optional
        csidl: i32,  // INT
        hToken: *mut core::ffi::c_void,  // HANDLE optional
        dwFlags: u32,  // DWORD
        pszSubDir: *const u8,  // LPCSTR optional
        pszPath: *mut u8  // LPSTR out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi)]
public static extern int SHGetFolderPathAndSubDirA(IntPtr hwnd, int csidl, IntPtr hToken, uint dwFlags, [MarshalAs(UnmanagedType.LPStr)] string pszSubDir, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszPath);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHGetFolderPathAndSubDirA' -Namespace Win32 -PassThru
# $api::SHGetFolderPathAndSubDirA(hwnd, csidl, hToken, dwFlags, pszSubDir, pszPath)

#uselib "SHELL32.dll"
#func global SHGetFolderPathAndSubDirA "SHGetFolderPathAndSubDirA" sptr, sptr, sptr, sptr, sptr, sptr
; SHGetFolderPathAndSubDirA hwnd, csidl, hToken, dwFlags, pszSubDir, varptr(pszPath)   ; 戻り値は stat
; hwnd : HWND optional -> "sptr"
; csidl : INT -> "sptr"
; hToken : HANDLE optional -> "sptr"
; dwFlags : DWORD -> "sptr"
; pszSubDir : LPCSTR optional -> "sptr"
; pszPath : LPSTR out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHELL32.dll"
#cfunc global SHGetFolderPathAndSubDirA "SHGetFolderPathAndSubDirA" sptr, int, sptr, int, str, var
; res = SHGetFolderPathAndSubDirA(hwnd, csidl, hToken, dwFlags, pszSubDir, pszPath)
; hwnd : HWND optional -> "sptr"
; csidl : INT -> "int"
; hToken : HANDLE optional -> "sptr"
; dwFlags : DWORD -> "int"
; pszSubDir : LPCSTR optional -> "str"
; pszPath : LPSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll"
#cfunc global SHGetFolderPathAndSubDirA "SHGetFolderPathAndSubDirA" sptr, int, sptr, int, str, sptr
; res = SHGetFolderPathAndSubDirA(hwnd, csidl, hToken, dwFlags, pszSubDir, varptr(pszPath))
; hwnd : HWND optional -> "sptr"
; csidl : INT -> "int"
; hToken : HANDLE optional -> "sptr"
; dwFlags : DWORD -> "int"
; pszSubDir : LPCSTR optional -> "str"
; pszPath : LPSTR out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。