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

ExpandEnvironmentStringsForUserA

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

シグネチャ

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

BOOL ExpandEnvironmentStringsForUserA(
    HANDLE hToken,   // optional
    LPCSTR lpSrc,
    LPSTR lpDest,
    DWORD dwSize
);

パラメーター

名前方向
hTokenHANDLEinoptional
lpSrcLPCSTRin
lpDestLPSTRout
dwSizeDWORDin

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL ExpandEnvironmentStringsForUserA(
    HANDLE hToken,   // optional
    LPCSTR lpSrc,
    LPSTR lpDest,
    DWORD dwSize
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool ExpandEnvironmentStringsForUserA(
    IntPtr hToken,   // HANDLE optional
    [MarshalAs(UnmanagedType.LPStr)] string lpSrc,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpDest,   // LPSTR out
    uint dwSize   // DWORD
);
<DllImport("USERENV.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ExpandEnvironmentStringsForUserA(
    hToken As IntPtr,   ' HANDLE optional
    <MarshalAs(UnmanagedType.LPStr)> lpSrc As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpDest As System.Text.StringBuilder,   ' LPSTR out
    dwSize As UInteger   ' DWORD
) As Boolean
End Function
' hToken : HANDLE optional
' lpSrc : LPCSTR
' lpDest : LPSTR out
' dwSize : DWORD
Declare PtrSafe Function ExpandEnvironmentStringsForUserA Lib "userenv" ( _
    ByVal hToken As LongPtr, _
    ByVal lpSrc As String, _
    ByVal lpDest As String, _
    ByVal dwSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ExpandEnvironmentStringsForUserA = ctypes.windll.userenv.ExpandEnvironmentStringsForUserA
ExpandEnvironmentStringsForUserA.restype = wintypes.BOOL
ExpandEnvironmentStringsForUserA.argtypes = [
    wintypes.HANDLE,  # hToken : HANDLE optional
    wintypes.LPCSTR,  # lpSrc : LPCSTR
    wintypes.LPSTR,  # lpDest : LPSTR 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')
ExpandEnvironmentStringsForUserA = Fiddle::Function.new(
  lib['ExpandEnvironmentStringsForUserA'],
  [
    Fiddle::TYPE_VOIDP,  # hToken : HANDLE optional
    Fiddle::TYPE_VOIDP,  # lpSrc : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpDest : LPSTR out
    -Fiddle::TYPE_INT,  # dwSize : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "userenv")]
extern "system" {
    fn ExpandEnvironmentStringsForUserA(
        hToken: *mut core::ffi::c_void,  // HANDLE optional
        lpSrc: *const u8,  // LPCSTR
        lpDest: *mut u8,  // LPSTR 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.Ansi, SetLastError = true)]
public static extern bool ExpandEnvironmentStringsForUserA(IntPtr hToken, [MarshalAs(UnmanagedType.LPStr)] string lpSrc, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpDest, uint dwSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USERENV_ExpandEnvironmentStringsForUserA' -Namespace Win32 -PassThru
# $api::ExpandEnvironmentStringsForUserA(hToken, lpSrc, lpDest, dwSize)
#uselib "USERENV.dll"
#func global ExpandEnvironmentStringsForUserA "ExpandEnvironmentStringsForUserA" sptr, sptr, sptr, sptr
; ExpandEnvironmentStringsForUserA hToken, lpSrc, varptr(lpDest), dwSize   ; 戻り値は stat
; hToken : HANDLE optional -> "sptr"
; lpSrc : LPCSTR -> "sptr"
; lpDest : LPSTR out -> "sptr"
; dwSize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USERENV.dll"
#cfunc global ExpandEnvironmentStringsForUserA "ExpandEnvironmentStringsForUserA" sptr, str, var, int
; res = ExpandEnvironmentStringsForUserA(hToken, lpSrc, lpDest, dwSize)
; hToken : HANDLE optional -> "sptr"
; lpSrc : LPCSTR -> "str"
; lpDest : LPSTR out -> "var"
; dwSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL ExpandEnvironmentStringsForUserA(HANDLE hToken, LPCSTR lpSrc, LPSTR lpDest, DWORD dwSize)
#uselib "USERENV.dll"
#cfunc global ExpandEnvironmentStringsForUserA "ExpandEnvironmentStringsForUserA" intptr, str, var, int
; res = ExpandEnvironmentStringsForUserA(hToken, lpSrc, lpDest, dwSize)
; hToken : HANDLE optional -> "intptr"
; lpSrc : LPCSTR -> "str"
; lpDest : LPSTR out -> "var"
; dwSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	userenv = windows.NewLazySystemDLL("USERENV.dll")
	procExpandEnvironmentStringsForUserA = userenv.NewProc("ExpandEnvironmentStringsForUserA")
)

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