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%VAR%形式の環境変数参照を含む展開元ANSI文字列。
lpDstLPSTRoutoptional展開後の文字列を受け取る出力バッファ。
nSizeDWORDinlpDstの文字数(終端含む)。必要サイズ問い合わせ時は0可。

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

extern "kernel32" fn ExpandEnvironmentStringsA(
    lpSrc: [*c]const u8, // LPCSTR
    lpDst: [*c]u8, // LPSTR optional, out
    nSize: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc ExpandEnvironmentStringsA(
    lpSrc: cstring,  # LPCSTR
    lpDst: ptr char,  # LPSTR optional, out
    nSize: uint32  # DWORD
): uint32 {.importc: "ExpandEnvironmentStringsA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
uint ExpandEnvironmentStringsA(
    const(char)* lpSrc,   // LPCSTR
    char* lpDst,   // LPSTR optional, out
    uint nSize   // DWORD
);
ccall((:ExpandEnvironmentStringsA, "KERNEL32.dll"), stdcall, UInt32,
      (Cstring, Ptr{UInt8}, UInt32),
      lpSrc, lpDst, nSize)
# lpSrc : LPCSTR -> Cstring
# lpDst : LPSTR optional, out -> Ptr{UInt8}
# nSize : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t ExpandEnvironmentStringsA(
    const char* lpSrc,
    char* lpDst,
    uint32_t nSize);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.ExpandEnvironmentStringsA(lpSrc, lpDst, nSize)
-- lpSrc : LPCSTR
-- lpDst : LPSTR optional, out
-- nSize : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const ExpandEnvironmentStringsA = lib.func('__stdcall', 'ExpandEnvironmentStringsA', 'uint32_t', ['str', 'char *', 'uint32_t']);
// ExpandEnvironmentStringsA(lpSrc, lpDst, nSize)
// lpSrc : LPCSTR -> 'str'
// lpDst : LPSTR optional, out -> 'char *'
// nSize : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  ExpandEnvironmentStringsA: { parameters: ["buffer", "buffer", "u32"], result: "u32" },
});
// lib.symbols.ExpandEnvironmentStringsA(lpSrc, lpDst, nSize)
// lpSrc : LPCSTR -> "buffer"
// lpDst : LPSTR optional, out -> "buffer"
// nSize : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t ExpandEnvironmentStringsA(
    const char* lpSrc,
    char* lpDst,
    uint32_t nSize);
C, "KERNEL32.dll");
// $ffi->ExpandEnvironmentStringsA(lpSrc, lpDst, nSize);
// lpSrc : LPCSTR
// lpDst : LPSTR optional, out
// nSize : 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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.ASCII_OPTIONS);
    int ExpandEnvironmentStringsA(
        String lpSrc,   // LPCSTR
        byte[] lpDst,   // LPSTR optional, out
        int nSize   // DWORD
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun ExpandEnvironmentStringsA = ExpandEnvironmentStringsA(
    lpSrc : UInt8*,   # LPCSTR
    lpDst : UInt8*,   # LPSTR optional, out
    nSize : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ExpandEnvironmentStringsANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Uint32);
typedef ExpandEnvironmentStringsADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int);
final ExpandEnvironmentStringsA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<ExpandEnvironmentStringsANative, ExpandEnvironmentStringsADart>('ExpandEnvironmentStringsA');
// lpSrc : LPCSTR -> Pointer<Utf8>
// lpDst : LPSTR optional, out -> Pointer<Utf8>
// nSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ExpandEnvironmentStringsA(
  lpSrc: PAnsiChar;   // LPCSTR
  lpDst: PAnsiChar;   // LPSTR optional, out
  nSize: DWORD   // DWORD
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'ExpandEnvironmentStringsA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ExpandEnvironmentStringsA"
  c_ExpandEnvironmentStringsA :: CString -> CString -> Word32 -> IO Word32
-- lpSrc : LPCSTR -> CString
-- lpDst : LPSTR optional, out -> CString
-- nSize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let expandenvironmentstringsa =
  foreign "ExpandEnvironmentStringsA"
    (string @-> string @-> uint32_t @-> returning uint32_t)
(* lpSrc : LPCSTR -> string *)
(* lpDst : LPSTR optional, out -> string *)
(* nSize : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("ExpandEnvironmentStringsA" expand-environment-strings-a :convention :stdcall) :uint32
  (lp-src :string)   ; LPCSTR
  (lp-dst :pointer)   ; LPSTR optional, out
  (n-size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ExpandEnvironmentStringsA = Win32::API::More->new('KERNEL32',
    'DWORD ExpandEnvironmentStringsA(LPCSTR lpSrc, LPSTR lpDst, DWORD nSize)');
# my $ret = $ExpandEnvironmentStringsA->Call($lpSrc, $lpDst, $nSize);
# lpSrc : LPCSTR -> LPCSTR
# lpDst : LPSTR optional, out -> LPSTR
# nSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い