ホーム › UI.Shell › SHGetSpecialFolderPathA

SHGetSpecialFolderPathA

関数

CSIDLで指定した特殊フォルダーのパス(ANSI)を取得する。

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

シグネチャ

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

BOOL SHGetSpecialFolderPathA(
    HWND hwnd,   // optional
    LPSTR pszPath,
    INT csidl,
    BOOL fCreate
);

パラメーター

名前	型	方向	説明
hwnd	HWND	optional	予約済みです。
pszPath	LPSTR	out	指定したフォルダーのドライブとパスを受け取る、null で終わる文字列へのポインターです。このバッファーのサイズは少なくとも MAX_PATH 文字分必要です。
csidl	INT	in	対象とするフォルダーを識別する CSIDL です。仮想フォルダーを指定した場合、この関数は失敗します。
fCreate	BOOL	in	フォルダーがまだ存在しない場合に作成するかどうかを示します。この値が 0 以外の場合、フォルダーが作成されます。この値が 0 の場合、フォルダーは作成されません。

戻り値の型: BOOL

公式ドキュメント

SHGetSpecialFolderPath はサポートされていません。代わりに ShGetFolderPath を使用してください。(ANSI)

戻り値

型: BOOL

成功した場合は TRUE、それ以外の場合は FALSE です。

解説(Remarks)

この関数を利用するには、Microsoft Internet Explorer 4.0 Desktop Update がインストールされている必要があります。

メモ

shlobj_core.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI バージョンと Unicode バージョンを自動的に選択するエイリアスとして SHGetSpecialFolderPath を定義しています。エンコード中立のエイリアスと、エンコード中立でないコードを混在させて使用すると、不一致が生じてコンパイルエラーや実行時エラーの原因となる場合があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

BOOL SHGetSpecialFolderPathA(
    HWND hwnd,   // optional
    LPSTR pszPath,
    INT csidl,
    BOOL fCreate
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool SHGetSpecialFolderPathA(
    IntPtr hwnd,   // HWND optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszPath,   // LPSTR out
    int csidl,   // INT
    bool fCreate   // BOOL
);

<DllImport("SHELL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHGetSpecialFolderPathA(
    hwnd As IntPtr,   ' HWND optional
    <MarshalAs(UnmanagedType.LPStr)> pszPath As System.Text.StringBuilder,   ' LPSTR out
    csidl As Integer,   ' INT
    fCreate As Boolean   ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

SHGetSpecialFolderPathA = ctypes.windll.shell32.SHGetSpecialFolderPathA
SHGetSpecialFolderPathA.restype = wintypes.BOOL
SHGetSpecialFolderPathA.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND optional
    wintypes.LPSTR,  # pszPath : LPSTR out
    ctypes.c_int,  # csidl : INT
    wintypes.BOOL,  # fCreate : BOOL
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHGetSpecialFolderPathA = Fiddle::Function.new(
  lib['SHGetSpecialFolderPathA'],
  [
    Fiddle::TYPE_VOIDP,  # hwnd : HWND optional
    Fiddle::TYPE_VOIDP,  # pszPath : LPSTR out
    Fiddle::TYPE_INT,  # csidl : INT
    Fiddle::TYPE_INT,  # fCreate : BOOL
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn SHGetSpecialFolderPathA(
        hwnd: *mut core::ffi::c_void,  // HWND optional
        pszPath: *mut u8,  // LPSTR out
        csidl: i32,  // INT
        fCreate: i32  // BOOL
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi)]
public static extern bool SHGetSpecialFolderPathA(IntPtr hwnd, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszPath, int csidl, bool fCreate);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHGetSpecialFolderPathA' -Namespace Win32 -PassThru
# $api::SHGetSpecialFolderPathA(hwnd, pszPath, csidl, fCreate)

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

出力引数:

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