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

ExpandEnvironmentStringsA

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

シグネチャ

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

DWORD ExpandEnvironmentStringsA(
    LPCSTR lpSrc,
    LPSTR lpDst,   // optional
    DWORD nSize
);

パラメーター

名前方向
lpSrcLPCSTRin
lpDstLPSTRoutoptional
nSizeDWORDin

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD ExpandEnvironmentStringsA(
    LPCSTR lpSrc,
    LPSTR lpDst,   // optional
    DWORD nSize
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern uint ExpandEnvironmentStringsA(
    [MarshalAs(UnmanagedType.LPStr)] string lpSrc,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpDst,   // LPSTR optional, out
    uint nSize   // DWORD
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ExpandEnvironmentStringsA(
    <MarshalAs(UnmanagedType.LPStr)> lpSrc As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpDst As System.Text.StringBuilder,   ' LPSTR optional, out
    nSize As UInteger   ' DWORD
) As UInteger
End Function
' lpSrc : LPCSTR
' lpDst : LPSTR optional, out
' nSize : DWORD
Declare PtrSafe Function ExpandEnvironmentStringsA Lib "kernel32" ( _
    ByVal lpSrc As String, _
    ByVal lpDst As String, _
    ByVal nSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ExpandEnvironmentStringsA = ctypes.windll.kernel32.ExpandEnvironmentStringsA
ExpandEnvironmentStringsA.restype = wintypes.DWORD
ExpandEnvironmentStringsA.argtypes = [
    wintypes.LPCSTR,  # lpSrc : LPCSTR
    wintypes.LPSTR,  # lpDst : LPSTR 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')
ExpandEnvironmentStringsA = Fiddle::Function.new(
  lib['ExpandEnvironmentStringsA'],
  [
    Fiddle::TYPE_VOIDP,  # lpSrc : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpDst : LPSTR optional, out
    -Fiddle::TYPE_INT,  # nSize : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn ExpandEnvironmentStringsA(
        lpSrc: *const u8,  // LPCSTR
        lpDst: *mut u8,  // LPSTR optional, out
        nSize: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern uint ExpandEnvironmentStringsA([MarshalAs(UnmanagedType.LPStr)] string lpSrc, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpDst, uint nSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_ExpandEnvironmentStringsA' -Namespace Win32 -PassThru
# $api::ExpandEnvironmentStringsA(lpSrc, lpDst, nSize)
#uselib "KERNEL32.dll"
#func global ExpandEnvironmentStringsA "ExpandEnvironmentStringsA" sptr, sptr, sptr
; ExpandEnvironmentStringsA lpSrc, varptr(lpDst), nSize   ; 戻り値は stat
; lpSrc : LPCSTR -> "sptr"
; lpDst : LPSTR optional, out -> "sptr"
; nSize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global ExpandEnvironmentStringsA "ExpandEnvironmentStringsA" str, var, int
; res = ExpandEnvironmentStringsA(lpSrc, lpDst, nSize)
; lpSrc : LPCSTR -> "str"
; lpDst : LPSTR optional, out -> "var"
; nSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD ExpandEnvironmentStringsA(LPCSTR lpSrc, LPSTR lpDst, DWORD nSize)
#uselib "KERNEL32.dll"
#cfunc global ExpandEnvironmentStringsA "ExpandEnvironmentStringsA" str, var, int
; res = ExpandEnvironmentStringsA(lpSrc, lpDst, nSize)
; lpSrc : LPCSTR -> "str"
; lpDst : LPSTR optional, out -> "var"
; nSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procExpandEnvironmentStringsA = kernel32.NewProc("ExpandEnvironmentStringsA")
)

// lpSrc (LPCSTR), lpDst (LPSTR optional, out), nSize (DWORD)
r1, _, err := procExpandEnvironmentStringsA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpSrc))),
	uintptr(lpDst),
	uintptr(nSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function ExpandEnvironmentStringsA(
  lpSrc: PAnsiChar;   // LPCSTR
  lpDst: PAnsiChar;   // LPSTR optional, out
  nSize: DWORD   // DWORD
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'ExpandEnvironmentStringsA';
result := DllCall("KERNEL32\ExpandEnvironmentStringsA"
    , "AStr", lpSrc   ; LPCSTR
    , "Ptr", lpDst   ; LPSTR optional, out
    , "UInt", nSize   ; DWORD
    , "UInt")   ; return: DWORD
●ExpandEnvironmentStringsA(lpSrc, lpDst, nSize) = DLL("KERNEL32.dll", "dword ExpandEnvironmentStringsA(char*, char*, dword)")
# 呼び出し: ExpandEnvironmentStringsA(lpSrc, lpDst, nSize)
# lpSrc : LPCSTR -> "char*"
# lpDst : LPSTR optional, out -> "char*"
# nSize : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。