ホーム › UI.Shell › PathUnExpandEnvStringsA

PathUnExpandEnvStringsA

関数

パス中の既定フォルダを環境変数表記に置き換える。

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

シグネチャ

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

BOOL PathUnExpandEnvStringsA(
    LPCSTR pszPath,
    LPSTR pszBuf,
    DWORD cchBuf
);

パラメーター

名前	型	方向	説明
pszPath	LPCSTR	in	アンエクスパンドするパスを格納した、最大長 MAX_PATH の null 終端文字列へのポインター。
pszBuf	LPSTR	out	このメソッドが正常に終了したときに、アンエクスパンドされた文字列を受け取るバッファーへのポインター。返される文字列を確実に保持できるよう、このバッファーのサイズは MAX_PATH に設定する必要があります。
cchBuf	DWORD	in	pszBuf バッファーのサイズ(文字数単位)。

戻り値の型: BOOL

公式ドキュメント

完全修飾パス内の特定のフォルダー名を、対応する環境文字列に置き換えます。(ANSI)

戻り値

型: BOOL

成功した場合は TRUE を返します。それ以外の場合は FALSE を返します。

解説(Remarks)

以下のフォルダーパスは、それぞれに対応する環境文字列に置き換えられます。

フォルダー	環境文字列
All Users プロファイルフォルダー	%ALLUSERSPROFILE%
現在のユーザーのアプリケーションデータフォルダー(Windows Vista 以降のみ)。	%APPDATA%
システム名	%COMPUTERNAME%
Program Files フォルダー	%ProgramFiles%
システムルートフォルダー	%SystemRoot%
システムドライブのドライブ文字	%SystemDrive%
現在のユーザーのプロファイルフォルダー	%USERPROFILE%

注意 %APPDATA% および %USERPROFILE% は、呼び出しを行うユーザーに対する相対値です。ユーザーがサービスから偽装されている場合、この関数は動作しません。アクセス制御の問題に関する詳細な説明については、アクセス制御を参照してください。

上記の表に記載されている環境変数は、すべてのシステムですべて設定されているとは限りません。環境変数が設定されていない場合、その変数はアンエクスパンドされません。

メモ

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

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

各言語での呼び出し定義

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

BOOL PathUnExpandEnvStringsA(
    LPCSTR pszPath,
    LPSTR pszBuf,
    DWORD cchBuf
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool PathUnExpandEnvStringsA(
    [MarshalAs(UnmanagedType.LPStr)] string pszPath,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszBuf,   // LPSTR out
    uint cchBuf   // DWORD
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PathUnExpandEnvStringsA(
    <MarshalAs(UnmanagedType.LPStr)> pszPath As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> pszBuf As System.Text.StringBuilder,   ' LPSTR out
    cchBuf As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pszPath : LPCSTR
' pszBuf : LPSTR out
' cchBuf : DWORD
Declare PtrSafe Function PathUnExpandEnvStringsA Lib "shlwapi" ( _
    ByVal pszPath As String, _
    ByVal pszBuf As String, _
    ByVal cchBuf As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PathUnExpandEnvStringsA = ctypes.windll.shlwapi.PathUnExpandEnvStringsA
PathUnExpandEnvStringsA.restype = wintypes.BOOL
PathUnExpandEnvStringsA.argtypes = [
    wintypes.LPCSTR,  # pszPath : LPCSTR
    wintypes.LPSTR,  # pszBuf : LPSTR out
    wintypes.DWORD,  # cchBuf : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathUnExpandEnvStringsA = Fiddle::Function.new(
  lib['PathUnExpandEnvStringsA'],
  [
    Fiddle::TYPE_VOIDP,  # pszPath : LPCSTR
    Fiddle::TYPE_VOIDP,  # pszBuf : LPSTR out
    -Fiddle::TYPE_INT,  # cchBuf : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "shlwapi")]
extern "system" {
    fn PathUnExpandEnvStringsA(
        pszPath: *const u8,  // LPCSTR
        pszBuf: *mut u8,  // LPSTR out
        cchBuf: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern bool PathUnExpandEnvStringsA([MarshalAs(UnmanagedType.LPStr)] string pszPath, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszBuf, uint cchBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathUnExpandEnvStringsA' -Namespace Win32 -PassThru
# $api::PathUnExpandEnvStringsA(pszPath, pszBuf, cchBuf)

#uselib "SHLWAPI.dll"
#func global PathUnExpandEnvStringsA "PathUnExpandEnvStringsA" sptr, sptr, sptr
; PathUnExpandEnvStringsA pszPath, varptr(pszBuf), cchBuf   ; 戻り値は stat
; pszPath : LPCSTR -> "sptr"
; pszBuf : LPSTR out -> "sptr"
; cchBuf : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHLWAPI.dll"
#cfunc global PathUnExpandEnvStringsA "PathUnExpandEnvStringsA" str, var, int
; res = PathUnExpandEnvStringsA(pszPath, pszBuf, cchBuf)
; pszPath : LPCSTR -> "str"
; pszBuf : LPSTR out -> "var"
; cchBuf : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll"
#cfunc global PathUnExpandEnvStringsA "PathUnExpandEnvStringsA" str, sptr, int
; res = PathUnExpandEnvStringsA(pszPath, varptr(pszBuf), cchBuf)
; pszPath : LPCSTR -> "str"
; pszBuf : LPSTR out -> "sptr"
; cchBuf : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。