Win32 API 日本語リファレンス
ホームSystem.Environment › ExpandEnvironmentStringsForUserW

ExpandEnvironmentStringsForUserW

関数
指定ユーザーの環境で文字列中の環境変数を展開する(Unicode版)。
DLLUSERENV.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL ExpandEnvironmentStringsForUserW(
    HANDLE hToken,   // optional
    LPCWSTR lpSrc,
    LPWSTR lpDest,
    DWORD dwSize
);

パラメーター

名前方向
hTokenHANDLEinoptional
lpSrcLPCWSTRin
lpDestLPWSTRout
dwSizeDWORDin

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL ExpandEnvironmentStringsForUserW(
    HANDLE hToken,   // optional
    LPCWSTR lpSrc,
    LPWSTR lpDest,
    DWORD dwSize
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool ExpandEnvironmentStringsForUserW(
    IntPtr hToken,   // HANDLE optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpSrc,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpDest,   // LPWSTR out
    uint dwSize   // DWORD
);
<DllImport("USERENV.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ExpandEnvironmentStringsForUserW(
    hToken As IntPtr,   ' HANDLE optional
    <MarshalAs(UnmanagedType.LPWStr)> lpSrc As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpDest As System.Text.StringBuilder,   ' LPWSTR out
    dwSize As UInteger   ' DWORD
) As Boolean
End Function
' hToken : HANDLE optional
' lpSrc : LPCWSTR
' lpDest : LPWSTR out
' dwSize : DWORD
Declare PtrSafe Function ExpandEnvironmentStringsForUserW Lib "userenv" ( _
    ByVal hToken As LongPtr, _
    ByVal lpSrc As LongPtr, _
    ByVal lpDest As LongPtr, _
    ByVal dwSize 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

ExpandEnvironmentStringsForUserW = ctypes.windll.userenv.ExpandEnvironmentStringsForUserW
ExpandEnvironmentStringsForUserW.restype = wintypes.BOOL
ExpandEnvironmentStringsForUserW.argtypes = [
    wintypes.HANDLE,  # hToken : HANDLE optional
    wintypes.LPCWSTR,  # lpSrc : LPCWSTR
    wintypes.LPWSTR,  # lpDest : LPWSTR out
    wintypes.DWORD,  # dwSize : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USERENV.dll')
ExpandEnvironmentStringsForUserW = Fiddle::Function.new(
  lib['ExpandEnvironmentStringsForUserW'],
  [
    Fiddle::TYPE_VOIDP,  # hToken : HANDLE optional
    Fiddle::TYPE_VOIDP,  # lpSrc : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpDest : LPWSTR out
    -Fiddle::TYPE_INT,  # dwSize : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "userenv")]
extern "system" {
    fn ExpandEnvironmentStringsForUserW(
        hToken: *mut core::ffi::c_void,  // HANDLE optional
        lpSrc: *const u16,  // LPCWSTR
        lpDest: *mut u16,  // LPWSTR out
        dwSize: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool ExpandEnvironmentStringsForUserW(IntPtr hToken, [MarshalAs(UnmanagedType.LPWStr)] string lpSrc, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpDest, uint dwSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USERENV_ExpandEnvironmentStringsForUserW' -Namespace Win32 -PassThru
# $api::ExpandEnvironmentStringsForUserW(hToken, lpSrc, lpDest, dwSize)
#uselib "USERENV.dll"
#func global ExpandEnvironmentStringsForUserW "ExpandEnvironmentStringsForUserW" wptr, wptr, wptr, wptr
; ExpandEnvironmentStringsForUserW hToken, lpSrc, varptr(lpDest), dwSize   ; 戻り値は stat
; hToken : HANDLE optional -> "wptr"
; lpSrc : LPCWSTR -> "wptr"
; lpDest : LPWSTR out -> "wptr"
; dwSize : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USERENV.dll"
#cfunc global ExpandEnvironmentStringsForUserW "ExpandEnvironmentStringsForUserW" sptr, wstr, var, int
; res = ExpandEnvironmentStringsForUserW(hToken, lpSrc, lpDest, dwSize)
; hToken : HANDLE optional -> "sptr"
; lpSrc : LPCWSTR -> "wstr"
; lpDest : LPWSTR out -> "var"
; dwSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL ExpandEnvironmentStringsForUserW(HANDLE hToken, LPCWSTR lpSrc, LPWSTR lpDest, DWORD dwSize)
#uselib "USERENV.dll"
#cfunc global ExpandEnvironmentStringsForUserW "ExpandEnvironmentStringsForUserW" intptr, wstr, var, int
; res = ExpandEnvironmentStringsForUserW(hToken, lpSrc, lpDest, dwSize)
; hToken : HANDLE optional -> "intptr"
; lpSrc : LPCWSTR -> "wstr"
; lpDest : LPWSTR out -> "var"
; dwSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	userenv = windows.NewLazySystemDLL("USERENV.dll")
	procExpandEnvironmentStringsForUserW = userenv.NewProc("ExpandEnvironmentStringsForUserW")
)

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