Win32 API 日本語リファレンス
ホームUI.Shell › PathUnExpandEnvStringsW

PathUnExpandEnvStringsW

関数
パス中の既定フォルダを環境変数表記に置き換える。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// SHLWAPI.dll  (Unicode / -W)
#include <windows.h>

BOOL PathUnExpandEnvStringsW(
    LPCWSTR pszPath,
    LPWSTR pszBuf,
    DWORD cchBuf
);

パラメーター

名前方向
pszPathLPCWSTRin
pszBufLPWSTRout
cchBufDWORDin

戻り値の型: BOOL

各言語での呼び出し定義

// SHLWAPI.dll  (Unicode / -W)
#include <windows.h>

BOOL PathUnExpandEnvStringsW(
    LPCWSTR pszPath,
    LPWSTR pszBuf,
    DWORD cchBuf
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool PathUnExpandEnvStringsW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszPath,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszBuf,   // LPWSTR out
    uint cchBuf   // DWORD
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PathUnExpandEnvStringsW(
    <MarshalAs(UnmanagedType.LPWStr)> pszPath As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pszBuf As System.Text.StringBuilder,   ' LPWSTR out
    cchBuf As UInteger   ' DWORD
) As Boolean
End Function
' pszPath : LPCWSTR
' pszBuf : LPWSTR out
' cchBuf : DWORD
Declare PtrSafe Function PathUnExpandEnvStringsW Lib "shlwapi" ( _
    ByVal pszPath As LongPtr, _
    ByVal pszBuf As LongPtr, _
    ByVal cchBuf As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PathUnExpandEnvStringsW = ctypes.windll.shlwapi.PathUnExpandEnvStringsW
PathUnExpandEnvStringsW.restype = wintypes.BOOL
PathUnExpandEnvStringsW.argtypes = [
    wintypes.LPCWSTR,  # pszPath : LPCWSTR
    wintypes.LPWSTR,  # pszBuf : LPWSTR out
    wintypes.DWORD,  # cchBuf : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathUnExpandEnvStringsW = Fiddle::Function.new(
  lib['PathUnExpandEnvStringsW'],
  [
    Fiddle::TYPE_VOIDP,  # pszPath : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pszBuf : LPWSTR out
    -Fiddle::TYPE_INT,  # cchBuf : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shlwapi")]
extern "system" {
    fn PathUnExpandEnvStringsW(
        pszPath: *const u16,  // LPCWSTR
        pszBuf: *mut u16,  // LPWSTR 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.Unicode)]
public static extern bool PathUnExpandEnvStringsW([MarshalAs(UnmanagedType.LPWStr)] string pszPath, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszBuf, uint cchBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathUnExpandEnvStringsW' -Namespace Win32 -PassThru
# $api::PathUnExpandEnvStringsW(pszPath, pszBuf, cchBuf)
#uselib "SHLWAPI.dll"
#func global PathUnExpandEnvStringsW "PathUnExpandEnvStringsW" wptr, wptr, wptr
; PathUnExpandEnvStringsW pszPath, varptr(pszBuf), cchBuf   ; 戻り値は stat
; pszPath : LPCWSTR -> "wptr"
; pszBuf : LPWSTR out -> "wptr"
; cchBuf : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global PathUnExpandEnvStringsW "PathUnExpandEnvStringsW" wstr, var, int
; res = PathUnExpandEnvStringsW(pszPath, pszBuf, cchBuf)
; pszPath : LPCWSTR -> "wstr"
; pszBuf : LPWSTR out -> "var"
; cchBuf : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL PathUnExpandEnvStringsW(LPCWSTR pszPath, LPWSTR pszBuf, DWORD cchBuf)
#uselib "SHLWAPI.dll"
#cfunc global PathUnExpandEnvStringsW "PathUnExpandEnvStringsW" wstr, var, int
; res = PathUnExpandEnvStringsW(pszPath, pszBuf, cchBuf)
; pszPath : LPCWSTR -> "wstr"
; pszBuf : LPWSTR out -> "var"
; cchBuf : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procPathUnExpandEnvStringsW = shlwapi.NewProc("PathUnExpandEnvStringsW")
)

// pszPath (LPCWSTR), pszBuf (LPWSTR out), cchBuf (DWORD)
r1, _, err := procPathUnExpandEnvStringsW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszPath))),
	uintptr(pszBuf),
	uintptr(cchBuf),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function PathUnExpandEnvStringsW(
  pszPath: PWideChar;   // LPCWSTR
  pszBuf: PWideChar;   // LPWSTR out
  cchBuf: DWORD   // DWORD
): BOOL; stdcall;
  external 'SHLWAPI.dll' name 'PathUnExpandEnvStringsW';
result := DllCall("SHLWAPI\PathUnExpandEnvStringsW"
    , "WStr", pszPath   ; LPCWSTR
    , "Ptr", pszBuf   ; LPWSTR out
    , "UInt", cchBuf   ; DWORD
    , "Int")   ; return: BOOL
●PathUnExpandEnvStringsW(pszPath, pszBuf, cchBuf) = DLL("SHLWAPI.dll", "bool PathUnExpandEnvStringsW(char*, char*, dword)")
# 呼び出し: PathUnExpandEnvStringsW(pszPath, pszBuf, cchBuf)
# pszPath : LPCWSTR -> "char*"
# pszBuf : LPWSTR out -> "char*"
# cchBuf : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。