PathUnExpandEnvStringsW
関数パス中の既定フォルダを環境変数表記に置き換える。
シグネチャ
// SHLWAPI.dll (Unicode / -W)
#include <windows.h>
BOOL PathUnExpandEnvStringsW(
LPCWSTR pszPath,
LPWSTR pszBuf,
DWORD cchBuf
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pszPath | LPCWSTR | in | 短縮(unexpand)するパスを格納した、最大長 MAX_PATH の null 終端文字列へのポインター。 |
| pszBuf | LPWSTR | out | このメソッドが正常に返ったときに、短縮された文字列を受け取るバッファーへのポインター。返される文字列を格納できる十分な大きさを確保するため、このバッファーのサイズは MAX_PATH に設定する必要があります。 |
| cchBuf | DWORD | in | pszBuf バッファーのサイズ(文字数単位)。 |
戻り値の型: BOOL
公式ドキュメント
完全修飾パス内の特定のフォルダー名を、対応する環境文字列に置き換えます。(Unicode)
戻り値
型: BOOL
成功した場合は TRUE を、それ以外の場合は FALSE を返します。
解説(Remarks)
以下のフォルダーパスは、対応する環境文字列に置き換えられます。
| フォルダー | 環境文字列 |
|---|---|
| All Users プロファイルフォルダー | %ALLUSERSPROFILE% |
| 現在のユーザーのアプリケーションデータフォルダー(Windows Vista 以降のみ)。 | %APPDATA% |
| システム名 | %COMPUTERNAME% |
| Program Files フォルダー | %ProgramFiles% |
| システムルートフォルダー | %SystemRoot% |
| システムドライブのドライブ文字 | %SystemDrive% |
| 現在のユーザーのプロファイルフォルダー | %USERPROFILE% |
注意 %APPDATA% と %USERPROFILE% は、呼び出しを行うユーザーに対する相対的なものです。この関数は、サービスからユーザーが偽装(impersonate)されている場合には動作しません。アクセス制御に関する問題の詳細については、Access Control を参照してください。
メモ
shlwapi.h ヘッダーは PathUnExpandEnvStrings をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版が自動的に選択されます。エンコーディング中立なエイリアスの使用と、エンコーディング中立でないコードを混在させると、不整合が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// 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 <MarshalAs(UnmanagedType.Bool)> 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 方式にも切替可。#uselib "SHLWAPI.dll" #cfunc global PathUnExpandEnvStringsW "PathUnExpandEnvStringsW" wstr, sptr, int ; res = PathUnExpandEnvStringsW(pszPath, varptr(pszBuf), cchBuf) ; pszPath : LPCWSTR -> "wstr" ; pszBuf : LPWSTR out -> "sptr" ; cchBuf : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは 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 方式にも切替可。; BOOL PathUnExpandEnvStringsW(LPCWSTR pszPath, LPWSTR pszBuf, DWORD cchBuf) #uselib "SHLWAPI.dll" #cfunc global PathUnExpandEnvStringsW "PathUnExpandEnvStringsW" wstr, intptr, int ; res = PathUnExpandEnvStringsW(pszPath, varptr(pszBuf), cchBuf) ; pszPath : LPCWSTR -> "wstr" ; pszBuf : LPWSTR out -> "intptr" ; cchBuf : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは 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 // BOOLfunction 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 版の利用を推奨。const std = @import("std");
extern "shlwapi" fn PathUnExpandEnvStringsW(
pszPath: [*c]const u16, // LPCWSTR
pszBuf: [*c]u16, // LPWSTR out
cchBuf: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc PathUnExpandEnvStringsW(
pszPath: WideCString, # LPCWSTR
pszBuf: ptr uint16, # LPWSTR out
cchBuf: uint32 # DWORD
): int32 {.importc: "PathUnExpandEnvStringsW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "shlwapi");
extern(Windows)
int PathUnExpandEnvStringsW(
const(wchar)* pszPath, // LPCWSTR
wchar* pszBuf, // LPWSTR out
uint cchBuf // DWORD
);ccall((:PathUnExpandEnvStringsW, "SHLWAPI.dll"), stdcall, Int32,
(Cwstring, Ptr{UInt16}, UInt32),
pszPath, pszBuf, cchBuf)
# pszPath : LPCWSTR -> Cwstring
# pszBuf : LPWSTR out -> Ptr{UInt16}
# cchBuf : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t PathUnExpandEnvStringsW(
const uint16_t* pszPath,
uint16_t* pszBuf,
uint32_t cchBuf);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.PathUnExpandEnvStringsW(pszPath, pszBuf, cchBuf)
-- pszPath : LPCWSTR
-- pszBuf : LPWSTR out
-- cchBuf : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const PathUnExpandEnvStringsW = lib.func('__stdcall', 'PathUnExpandEnvStringsW', 'int32_t', ['str16', 'uint16_t *', 'uint32_t']);
// PathUnExpandEnvStringsW(pszPath, pszBuf, cchBuf)
// pszPath : LPCWSTR -> 'str16'
// pszBuf : LPWSTR out -> 'uint16_t *'
// cchBuf : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
PathUnExpandEnvStringsW: { parameters: ["buffer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.PathUnExpandEnvStringsW(pszPath, pszBuf, cchBuf)
// pszPath : LPCWSTR -> "buffer"
// pszBuf : LPWSTR out -> "buffer"
// cchBuf : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t PathUnExpandEnvStringsW(
const uint16_t* pszPath,
uint16_t* pszBuf,
uint32_t cchBuf);
C, "SHLWAPI.dll");
// $ffi->PathUnExpandEnvStringsW(pszPath, pszBuf, cchBuf);
// pszPath : LPCWSTR
// pszBuf : LPWSTR out
// cchBuf : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Shlwapi extends StdCallLibrary {
Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.UNICODE_OPTIONS);
boolean PathUnExpandEnvStringsW(
WString pszPath, // LPCWSTR
char[] pszBuf, // LPWSTR out
int cchBuf // DWORD
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("shlwapi")]
lib LibSHLWAPI
fun PathUnExpandEnvStringsW = PathUnExpandEnvStringsW(
pszPath : UInt16*, # LPCWSTR
pszBuf : UInt16*, # LPWSTR out
cchBuf : UInt32 # DWORD
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef PathUnExpandEnvStringsWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef PathUnExpandEnvStringsWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int);
final PathUnExpandEnvStringsW = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<PathUnExpandEnvStringsWNative, PathUnExpandEnvStringsWDart>('PathUnExpandEnvStringsW');
// pszPath : LPCWSTR -> Pointer<Utf16>
// pszBuf : LPWSTR out -> Pointer<Utf16>
// cchBuf : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function PathUnExpandEnvStringsW(
pszPath: PWideChar; // LPCWSTR
pszBuf: PWideChar; // LPWSTR out
cchBuf: DWORD // DWORD
): BOOL; stdcall;
external 'SHLWAPI.dll' name 'PathUnExpandEnvStringsW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "PathUnExpandEnvStringsW"
c_PathUnExpandEnvStringsW :: CWString -> CWString -> Word32 -> IO CInt
-- pszPath : LPCWSTR -> CWString
-- pszBuf : LPWSTR out -> CWString
-- cchBuf : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let pathunexpandenvstringsw =
foreign "PathUnExpandEnvStringsW"
((ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* pszPath : LPCWSTR -> (ptr uint16_t) *)
(* pszBuf : LPWSTR out -> (ptr uint16_t) *)
(* cchBuf : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)
(cffi:defcfun ("PathUnExpandEnvStringsW" path-un-expand-env-strings-w :convention :stdcall) :int32
(psz-path (:string :encoding :utf-16le)) ; LPCWSTR
(psz-buf :pointer) ; LPWSTR out
(cch-buf :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $PathUnExpandEnvStringsW = Win32::API::More->new('SHLWAPI',
'BOOL PathUnExpandEnvStringsW(LPCWSTR pszPath, LPWSTR pszBuf, DWORD cchBuf)');
# my $ret = $PathUnExpandEnvStringsW->Call($pszPath, $pszBuf, $cchBuf);
# pszPath : LPCWSTR -> LPCWSTR
# pszBuf : LPWSTR out -> LPWSTR
# cchBuf : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f PathUnExpandEnvStringsA (ANSI版) — パス中の既定フォルダを環境変数表記に置き換える。
公式の関連項目
- f DoEnvironmentSubstW — 文字列内の環境変数参照を実際の値に置換する。