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

ExpandEnvironmentStringsW

関数
文字列中の環境変数参照を実際の値に展開する(Unicode版)。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

DWORD ExpandEnvironmentStringsW(
    LPCWSTR lpSrc,
    LPWSTR lpDst,   // optional
    DWORD nSize
);

パラメーター

名前方向
lpSrcLPCWSTRin
lpDstLPWSTRoutoptional
nSizeDWORDin

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD ExpandEnvironmentStringsW(
    LPCWSTR lpSrc,
    LPWSTR lpDst,   // optional
    DWORD nSize
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint ExpandEnvironmentStringsW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpSrc,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpDst,   // LPWSTR optional, out
    uint nSize   // DWORD
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ExpandEnvironmentStringsW(
    <MarshalAs(UnmanagedType.LPWStr)> lpSrc As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpDst As System.Text.StringBuilder,   ' LPWSTR optional, out
    nSize As UInteger   ' DWORD
) As UInteger
End Function
' lpSrc : LPCWSTR
' lpDst : LPWSTR optional, out
' nSize : DWORD
Declare PtrSafe Function ExpandEnvironmentStringsW Lib "kernel32" ( _
    ByVal lpSrc As LongPtr, _
    ByVal lpDst As LongPtr, _
    ByVal nSize 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

ExpandEnvironmentStringsW = ctypes.windll.kernel32.ExpandEnvironmentStringsW
ExpandEnvironmentStringsW.restype = wintypes.DWORD
ExpandEnvironmentStringsW.argtypes = [
    wintypes.LPCWSTR,  # lpSrc : LPCWSTR
    wintypes.LPWSTR,  # lpDst : LPWSTR optional, out
    wintypes.DWORD,  # nSize : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procExpandEnvironmentStringsW = kernel32.NewProc("ExpandEnvironmentStringsW")
)

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