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

ExpandEnvironmentStringsForUserW

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

シグネチャ

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

BOOL ExpandEnvironmentStringsForUserW(
    HANDLE hToken,   // optional
    LPCWSTR lpSrc,
    LPWSTR lpDest,
    DWORD dwSize
);

パラメーター

名前方向説明
hTokenHANDLEinoptional対象ユーザーのアクセストークン。NULLで現在のユーザー。
lpSrcLPCWSTRin%VAR%参照を含む展開元ワイド文字列。
lpDestLPWSTRout展開後の文字列を受け取るワイド出力バッファ。
dwSizeDWORDinlpDestの文字数。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL ExpandEnvironmentStringsForUserW(
    HANDLE hToken,   // optional
    LPCWSTR lpSrc,
    LPWSTR lpDest,
    DWORD dwSize
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool ExpandEnvironmentStringsForUserW(
    IntPtr hToken,   // HANDLE optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpSrc,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpDest,   // LPWSTR out
    uint dwSize   // DWORD
);
<DllImport("USERENV.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ExpandEnvironmentStringsForUserW(
    hToken As IntPtr,   ' HANDLE optional
    <MarshalAs(UnmanagedType.LPWStr)> lpSrc As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpDest As System.Text.StringBuilder,   ' LPWSTR out
    dwSize As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hToken : HANDLE optional
' lpSrc : LPCWSTR
' lpDest : LPWSTR out
' dwSize : DWORD
Declare PtrSafe Function ExpandEnvironmentStringsForUserW Lib "userenv" ( _
    ByVal hToken As LongPtr, _
    ByVal lpSrc As LongPtr, _
    ByVal lpDest As LongPtr, _
    ByVal dwSize 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

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

var (
	userenv = windows.NewLazySystemDLL("USERENV.dll")
	procExpandEnvironmentStringsForUserW = userenv.NewProc("ExpandEnvironmentStringsForUserW")
)

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

extern "userenv" fn ExpandEnvironmentStringsForUserW(
    hToken: ?*anyopaque, // HANDLE optional
    lpSrc: [*c]const u16, // LPCWSTR
    lpDest: [*c]u16, // LPWSTR out
    dwSize: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc ExpandEnvironmentStringsForUserW(
    hToken: pointer,  # HANDLE optional
    lpSrc: WideCString,  # LPCWSTR
    lpDest: ptr uint16,  # LPWSTR out
    dwSize: uint32  # DWORD
): int32 {.importc: "ExpandEnvironmentStringsForUserW", stdcall, dynlib: "USERENV.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "userenv");
extern(Windows)
int ExpandEnvironmentStringsForUserW(
    void* hToken,   // HANDLE optional
    const(wchar)* lpSrc,   // LPCWSTR
    wchar* lpDest,   // LPWSTR out
    uint dwSize   // DWORD
);
ccall((:ExpandEnvironmentStringsForUserW, "USERENV.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring, Ptr{UInt16}, UInt32),
      hToken, lpSrc, lpDest, dwSize)
# hToken : HANDLE optional -> Ptr{Cvoid}
# lpSrc : LPCWSTR -> Cwstring
# lpDest : LPWSTR out -> Ptr{UInt16}
# dwSize : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t ExpandEnvironmentStringsForUserW(
    void* hToken,
    const uint16_t* lpSrc,
    uint16_t* lpDest,
    uint32_t dwSize);
]]
local userenv = ffi.load("userenv")
-- userenv.ExpandEnvironmentStringsForUserW(hToken, lpSrc, lpDest, dwSize)
-- hToken : HANDLE optional
-- lpSrc : LPCWSTR
-- lpDest : LPWSTR out
-- dwSize : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('USERENV.dll');
const ExpandEnvironmentStringsForUserW = lib.func('__stdcall', 'ExpandEnvironmentStringsForUserW', 'int32_t', ['void *', 'str16', 'uint16_t *', 'uint32_t']);
// ExpandEnvironmentStringsForUserW(hToken, lpSrc, lpDest, dwSize)
// hToken : HANDLE optional -> 'void *'
// lpSrc : LPCWSTR -> 'str16'
// lpDest : LPWSTR out -> 'uint16_t *'
// dwSize : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USERENV.dll", {
  ExpandEnvironmentStringsForUserW: { parameters: ["pointer", "buffer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.ExpandEnvironmentStringsForUserW(hToken, lpSrc, lpDest, dwSize)
// hToken : HANDLE optional -> "pointer"
// lpSrc : LPCWSTR -> "buffer"
// lpDest : LPWSTR out -> "buffer"
// dwSize : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ExpandEnvironmentStringsForUserW(
    void* hToken,
    const uint16_t* lpSrc,
    uint16_t* lpDest,
    uint32_t dwSize);
C, "USERENV.dll");
// $ffi->ExpandEnvironmentStringsForUserW(hToken, lpSrc, lpDest, dwSize);
// hToken : HANDLE optional
// lpSrc : LPCWSTR
// lpDest : LPWSTR 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.UNICODE_OPTIONS);
    boolean ExpandEnvironmentStringsForUserW(
        Pointer hToken,   // HANDLE optional
        WString lpSrc,   // LPCWSTR
        char[] lpDest,   // LPWSTR out
        int dwSize   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("userenv")]
lib LibUSERENV
  fun ExpandEnvironmentStringsForUserW = ExpandEnvironmentStringsForUserW(
    hToken : Void*,   # HANDLE optional
    lpSrc : UInt16*,   # LPCWSTR
    lpDest : UInt16*,   # LPWSTR 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 ExpandEnvironmentStringsForUserWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef ExpandEnvironmentStringsForUserWDart = int Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, int);
final ExpandEnvironmentStringsForUserW = DynamicLibrary.open('USERENV.dll')
    .lookupFunction<ExpandEnvironmentStringsForUserWNative, ExpandEnvironmentStringsForUserWDart>('ExpandEnvironmentStringsForUserW');
// hToken : HANDLE optional -> Pointer<Void>
// lpSrc : LPCWSTR -> Pointer<Utf16>
// lpDest : LPWSTR out -> Pointer<Utf16>
// dwSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ExpandEnvironmentStringsForUserW(
  hToken: THandle;   // HANDLE optional
  lpSrc: PWideChar;   // LPCWSTR
  lpDest: PWideChar;   // LPWSTR out
  dwSize: DWORD   // DWORD
): BOOL; stdcall;
  external 'USERENV.dll' name 'ExpandEnvironmentStringsForUserW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let expandenvironmentstringsforuserw =
  foreign "ExpandEnvironmentStringsForUserW"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* hToken : HANDLE optional -> (ptr void) *)
(* lpSrc : LPCWSTR -> (ptr uint16_t) *)
(* lpDest : LPWSTR out -> (ptr uint16_t) *)
(* 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 ("ExpandEnvironmentStringsForUserW" expand-environment-strings-for-user-w :convention :stdcall) :int32
  (h-token :pointer)   ; HANDLE optional
  (lp-src (:string :encoding :utf-16le))   ; LPCWSTR
  (lp-dest :pointer)   ; LPWSTR out
  (dw-size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ExpandEnvironmentStringsForUserW = Win32::API::More->new('USERENV',
    'BOOL ExpandEnvironmentStringsForUserW(HANDLE hToken, LPCWSTR lpSrc, LPWSTR lpDest, DWORD dwSize)');
# my $ret = $ExpandEnvironmentStringsForUserW->Call($hToken, $lpSrc, $lpDest, $dwSize);
# hToken : HANDLE optional -> HANDLE
# lpSrc : LPCWSTR -> LPCWSTR
# lpDest : LPWSTR out -> LPWSTR
# dwSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い