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

GetEnvironmentVariableW

関数
指定した環境変数の値を取得する(Unicode版)。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

DWORD GetEnvironmentVariableW(
    LPCWSTR lpName,   // optional
    LPWSTR lpBuffer,   // optional
    DWORD nSize
);

パラメーター

名前方向説明
lpNameLPCWSTRinoptional取得する環境変数名を指すワイド文字列。
lpBufferLPWSTRoutoptional変数値を受け取る出力バッファ。サイズ問い合わせ時はNULL可。
nSizeDWORDinlpBufferの文字数(終端含む)。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD GetEnvironmentVariableW(
    LPCWSTR lpName,   // optional
    LPWSTR lpBuffer,   // optional
    DWORD nSize
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint GetEnvironmentVariableW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBuffer,   // LPWSTR optional, out
    uint nSize   // DWORD
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetEnvironmentVariableW(
    <MarshalAs(UnmanagedType.LPWStr)> lpName As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpBuffer As System.Text.StringBuilder,   ' LPWSTR optional, out
    nSize As UInteger   ' DWORD
) As UInteger
End Function
' lpName : LPCWSTR optional
' lpBuffer : LPWSTR optional, out
' nSize : DWORD
Declare PtrSafe Function GetEnvironmentVariableW Lib "kernel32" ( _
    ByVal lpName As LongPtr, _
    ByVal lpBuffer As LongPtr, _
    ByVal nSize 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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetEnvironmentVariableW = kernel32.NewProc("GetEnvironmentVariableW")
)

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

extern "kernel32" fn GetEnvironmentVariableW(
    lpName: [*c]const u16, // LPCWSTR optional
    lpBuffer: [*c]u16, // LPWSTR optional, out
    nSize: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetEnvironmentVariableW(
    lpName: WideCString,  # LPCWSTR optional
    lpBuffer: ptr uint16,  # LPWSTR optional, out
    nSize: uint32  # DWORD
): uint32 {.importc: "GetEnvironmentVariableW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
uint GetEnvironmentVariableW(
    const(wchar)* lpName,   // LPCWSTR optional
    wchar* lpBuffer,   // LPWSTR optional, out
    uint nSize   // DWORD
);
ccall((:GetEnvironmentVariableW, "KERNEL32.dll"), stdcall, UInt32,
      (Cwstring, Ptr{UInt16}, UInt32),
      lpName, lpBuffer, nSize)
# lpName : LPCWSTR optional -> Cwstring
# lpBuffer : LPWSTR optional, out -> Ptr{UInt16}
# nSize : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetEnvironmentVariableW(
    const uint16_t* lpName,
    uint16_t* lpBuffer,
    uint32_t nSize);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetEnvironmentVariableW(lpName, lpBuffer, nSize)
-- lpName : LPCWSTR optional
-- lpBuffer : LPWSTR optional, out
-- nSize : 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('KERNEL32.dll');
const GetEnvironmentVariableW = lib.func('__stdcall', 'GetEnvironmentVariableW', 'uint32_t', ['str16', 'uint16_t *', 'uint32_t']);
// GetEnvironmentVariableW(lpName, lpBuffer, nSize)
// lpName : LPCWSTR optional -> 'str16'
// lpBuffer : LPWSTR optional, out -> 'uint16_t *'
// nSize : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetEnvironmentVariableW: { parameters: ["buffer", "buffer", "u32"], result: "u32" },
});
// lib.symbols.GetEnvironmentVariableW(lpName, lpBuffer, nSize)
// lpName : LPCWSTR optional -> "buffer"
// lpBuffer : LPWSTR optional, out -> "buffer"
// nSize : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetEnvironmentVariableW(
    const uint16_t* lpName,
    uint16_t* lpBuffer,
    uint32_t nSize);
C, "KERNEL32.dll");
// $ffi->GetEnvironmentVariableW(lpName, lpBuffer, nSize);
// lpName : LPCWSTR optional
// lpBuffer : LPWSTR 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.UNICODE_OPTIONS);
    int GetEnvironmentVariableW(
        WString lpName,   // LPCWSTR optional
        char[] lpBuffer,   // LPWSTR optional, out
        int nSize   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun GetEnvironmentVariableW = GetEnvironmentVariableW(
    lpName : UInt16*,   # LPCWSTR optional
    lpBuffer : UInt16*,   # LPWSTR 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 GetEnvironmentVariableWNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef GetEnvironmentVariableWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int);
final GetEnvironmentVariableW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetEnvironmentVariableWNative, GetEnvironmentVariableWDart>('GetEnvironmentVariableW');
// lpName : LPCWSTR optional -> Pointer<Utf16>
// lpBuffer : LPWSTR optional, out -> Pointer<Utf16>
// nSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetEnvironmentVariableW(
  lpName: PWideChar;   // LPCWSTR optional
  lpBuffer: PWideChar;   // LPWSTR optional, out
  nSize: DWORD   // DWORD
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetEnvironmentVariableW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetEnvironmentVariableW"
  c_GetEnvironmentVariableW :: CWString -> CWString -> Word32 -> IO Word32
-- lpName : LPCWSTR optional -> CWString
-- lpBuffer : LPWSTR optional, out -> CWString
-- nSize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getenvironmentvariablew =
  foreign "GetEnvironmentVariableW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning uint32_t)
(* lpName : LPCWSTR optional -> (ptr uint16_t) *)
(* lpBuffer : LPWSTR optional, out -> (ptr uint16_t) *)
(* 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 ("GetEnvironmentVariableW" get-environment-variable-w :convention :stdcall) :uint32
  (lp-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (lp-buffer :pointer)   ; LPWSTR optional, out
  (n-size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetEnvironmentVariableW = Win32::API::More->new('KERNEL32',
    'DWORD GetEnvironmentVariableW(LPCWSTR lpName, LPWSTR lpBuffer, DWORD nSize)');
# my $ret = $GetEnvironmentVariableW->Call($lpName, $lpBuffer, $nSize);
# lpName : LPCWSTR optional -> LPCWSTR
# lpBuffer : LPWSTR optional, out -> LPWSTR
# nSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い