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対象ユーザーのアクセストークン。NULLで現在のユーザー。
lpSrcLPCSTRin%VAR%参照を含む展開元ANSI文字列。
lpDestLPSTRout展開後の文字列を受け取るANSI出力バッファ。
dwSizeDWORDinlpDestの文字数。

戻り値の型: 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 <MarshalAs(UnmanagedType.Bool)> 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)。
const std = @import("std");

extern "userenv" fn ExpandEnvironmentStringsForUserA(
    hToken: ?*anyopaque, // HANDLE optional
    lpSrc: [*c]const u8, // LPCSTR
    lpDest: [*c]u8, // LPSTR out
    dwSize: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc ExpandEnvironmentStringsForUserA(
    hToken: pointer,  # HANDLE optional
    lpSrc: cstring,  # LPCSTR
    lpDest: ptr char,  # LPSTR out
    dwSize: uint32  # DWORD
): int32 {.importc: "ExpandEnvironmentStringsForUserA", stdcall, dynlib: "USERENV.dll".}
pragma(lib, "userenv");
extern(Windows)
int ExpandEnvironmentStringsForUserA(
    void* hToken,   // HANDLE optional
    const(char)* lpSrc,   // LPCSTR
    char* lpDest,   // LPSTR out
    uint dwSize   // DWORD
);
ccall((:ExpandEnvironmentStringsForUserA, "USERENV.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cstring, Ptr{UInt8}, UInt32),
      hToken, lpSrc, lpDest, dwSize)
# hToken : HANDLE optional -> Ptr{Cvoid}
# lpSrc : LPCSTR -> Cstring
# lpDest : LPSTR out -> Ptr{UInt8}
# dwSize : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t ExpandEnvironmentStringsForUserA(
    void* hToken,
    const char* lpSrc,
    char* lpDest,
    uint32_t dwSize);
]]
local userenv = ffi.load("userenv")
-- userenv.ExpandEnvironmentStringsForUserA(hToken, lpSrc, lpDest, dwSize)
-- hToken : HANDLE optional
-- lpSrc : LPCSTR
-- lpDest : LPSTR out
-- dwSize : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USERENV.dll');
const ExpandEnvironmentStringsForUserA = lib.func('__stdcall', 'ExpandEnvironmentStringsForUserA', 'int32_t', ['void *', 'str', 'char *', 'uint32_t']);
// ExpandEnvironmentStringsForUserA(hToken, lpSrc, lpDest, dwSize)
// hToken : HANDLE optional -> 'void *'
// lpSrc : LPCSTR -> 'str'
// lpDest : LPSTR out -> 'char *'
// dwSize : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USERENV.dll", {
  ExpandEnvironmentStringsForUserA: { parameters: ["pointer", "buffer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.ExpandEnvironmentStringsForUserA(hToken, lpSrc, lpDest, dwSize)
// hToken : HANDLE optional -> "pointer"
// lpSrc : LPCSTR -> "buffer"
// lpDest : LPSTR out -> "buffer"
// dwSize : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ExpandEnvironmentStringsForUserA(
    void* hToken,
    const char* lpSrc,
    char* lpDest,
    uint32_t dwSize);
C, "USERENV.dll");
// $ffi->ExpandEnvironmentStringsForUserA(hToken, lpSrc, lpDest, dwSize);
// hToken : HANDLE optional
// lpSrc : LPCSTR
// lpDest : LPSTR out
// dwSize : 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 Userenv extends StdCallLibrary {
    Userenv INSTANCE = Native.load("userenv", Userenv.class, W32APIOptions.ASCII_OPTIONS);
    boolean ExpandEnvironmentStringsForUserA(
        Pointer hToken,   // HANDLE optional
        String lpSrc,   // LPCSTR
        byte[] lpDest,   // LPSTR out
        int dwSize   // DWORD
    );
}
@[Link("userenv")]
lib LibUSERENV
  fun ExpandEnvironmentStringsForUserA = ExpandEnvironmentStringsForUserA(
    hToken : Void*,   # HANDLE optional
    lpSrc : UInt8*,   # LPCSTR
    lpDest : UInt8*,   # LPSTR out
    dwSize : 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 ExpandEnvironmentStringsForUserANative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Uint32);
typedef ExpandEnvironmentStringsForUserADart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, int);
final ExpandEnvironmentStringsForUserA = DynamicLibrary.open('USERENV.dll')
    .lookupFunction<ExpandEnvironmentStringsForUserANative, ExpandEnvironmentStringsForUserADart>('ExpandEnvironmentStringsForUserA');
// hToken : HANDLE optional -> Pointer<Void>
// lpSrc : LPCSTR -> Pointer<Utf8>
// lpDest : LPSTR out -> Pointer<Utf8>
// dwSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ExpandEnvironmentStringsForUserA(
  hToken: THandle;   // HANDLE optional
  lpSrc: PAnsiChar;   // LPCSTR
  lpDest: PAnsiChar;   // LPSTR out
  dwSize: DWORD   // DWORD
): BOOL; stdcall;
  external 'USERENV.dll' name 'ExpandEnvironmentStringsForUserA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ExpandEnvironmentStringsForUserA"
  c_ExpandEnvironmentStringsForUserA :: Ptr () -> CString -> CString -> Word32 -> IO CInt
-- hToken : HANDLE optional -> Ptr ()
-- lpSrc : LPCSTR -> CString
-- lpDest : LPSTR out -> CString
-- dwSize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let expandenvironmentstringsforusera =
  foreign "ExpandEnvironmentStringsForUserA"
    ((ptr void) @-> string @-> string @-> uint32_t @-> returning int32_t)
(* hToken : HANDLE optional -> (ptr void) *)
(* lpSrc : LPCSTR -> string *)
(* lpDest : LPSTR out -> string *)
(* dwSize : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library userenv (t "USERENV.dll"))
(cffi:use-foreign-library userenv)

(cffi:defcfun ("ExpandEnvironmentStringsForUserA" expand-environment-strings-for-user-a :convention :stdcall) :int32
  (h-token :pointer)   ; HANDLE optional
  (lp-src :string)   ; LPCSTR
  (lp-dest :pointer)   ; LPSTR out
  (dw-size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ExpandEnvironmentStringsForUserA = Win32::API::More->new('USERENV',
    'BOOL ExpandEnvironmentStringsForUserA(HANDLE hToken, LPCSTR lpSrc, LPSTR lpDest, DWORD dwSize)');
# my $ret = $ExpandEnvironmentStringsForUserA->Call($hToken, $lpSrc, $lpDest, $dwSize);
# hToken : HANDLE optional -> HANDLE
# lpSrc : LPCSTR -> LPCSTR
# lpDest : LPSTR out -> LPSTR
# dwSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い