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

GetFirmwareEnvironmentVariableExW

関数
属性付きでファームウェア環境変数の値をUnicodeで取得する。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSwindows8.0

シグネチャ

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

DWORD GetFirmwareEnvironmentVariableExW(
    LPCWSTR lpName,
    LPCWSTR lpGuid,
    void* pBuffer,   // optional
    DWORD nSize,
    DWORD* pdwAttribubutes   // optional
);

パラメーター

名前方向説明
lpNameLPCWSTRin取得するファームウェア環境変数の名前(ワイド文字列)。
lpGuidLPCWSTRin変数が属する名前空間を表すGUID文字列(ワイド)。
pBuffervoid*outoptional取得した変数値を格納するバッファへのポインタ。
nSizeDWORDinバッファpBufferのサイズ(バイト数)。
pdwAttribubutesDWORD*outoptional変数の属性ビット(揮発性/ブート時アクセス等)を受け取る出力ポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

GetFirmwareEnvironmentVariableExW = ctypes.windll.kernel32.GetFirmwareEnvironmentVariableExW
GetFirmwareEnvironmentVariableExW.restype = wintypes.DWORD
GetFirmwareEnvironmentVariableExW.argtypes = [
    wintypes.LPCWSTR,  # lpName : LPCWSTR
    wintypes.LPCWSTR,  # lpGuid : LPCWSTR
    ctypes.POINTER(None),  # pBuffer : void* optional, out
    wintypes.DWORD,  # nSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pdwAttribubutes : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetFirmwareEnvironmentVariableExW = kernel32.NewProc("GetFirmwareEnvironmentVariableExW")
)

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

extern "kernel32" fn GetFirmwareEnvironmentVariableExW(
    lpName: [*c]const u16, // LPCWSTR
    lpGuid: [*c]const u16, // LPCWSTR
    pBuffer: ?*anyopaque, // void* optional, out
    nSize: u32, // DWORD
    pdwAttribubutes: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetFirmwareEnvironmentVariableExW(
    lpName: WideCString,  # LPCWSTR
    lpGuid: WideCString,  # LPCWSTR
    pBuffer: pointer,  # void* optional, out
    nSize: uint32,  # DWORD
    pdwAttribubutes: ptr uint32  # DWORD* optional, out
): uint32 {.importc: "GetFirmwareEnvironmentVariableExW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
uint GetFirmwareEnvironmentVariableExW(
    const(wchar)* lpName,   // LPCWSTR
    const(wchar)* lpGuid,   // LPCWSTR
    void* pBuffer,   // void* optional, out
    uint nSize,   // DWORD
    uint* pdwAttribubutes   // DWORD* optional, out
);
ccall((:GetFirmwareEnvironmentVariableExW, "KERNEL32.dll"), stdcall, UInt32,
      (Cwstring, Cwstring, Ptr{Cvoid}, UInt32, Ptr{UInt32}),
      lpName, lpGuid, pBuffer, nSize, pdwAttribubutes)
# lpName : LPCWSTR -> Cwstring
# lpGuid : LPCWSTR -> Cwstring
# pBuffer : void* optional, out -> Ptr{Cvoid}
# nSize : DWORD -> UInt32
# pdwAttribubutes : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetFirmwareEnvironmentVariableExW(
    const uint16_t* lpName,
    const uint16_t* lpGuid,
    void* pBuffer,
    uint32_t nSize,
    uint32_t* pdwAttribubutes);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetFirmwareEnvironmentVariableExW(lpName, lpGuid, pBuffer, nSize, pdwAttribubutes)
-- lpName : LPCWSTR
-- lpGuid : LPCWSTR
-- pBuffer : void* optional, out
-- nSize : DWORD
-- pdwAttribubutes : DWORD* optional, out
-- 構造体/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 GetFirmwareEnvironmentVariableExW = lib.func('__stdcall', 'GetFirmwareEnvironmentVariableExW', 'uint32_t', ['str16', 'str16', 'void *', 'uint32_t', 'uint32_t *']);
// GetFirmwareEnvironmentVariableExW(lpName, lpGuid, pBuffer, nSize, pdwAttribubutes)
// lpName : LPCWSTR -> 'str16'
// lpGuid : LPCWSTR -> 'str16'
// pBuffer : void* optional, out -> 'void *'
// nSize : DWORD -> 'uint32_t'
// pdwAttribubutes : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetFirmwareEnvironmentVariableExW: { parameters: ["buffer", "buffer", "pointer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.GetFirmwareEnvironmentVariableExW(lpName, lpGuid, pBuffer, nSize, pdwAttribubutes)
// lpName : LPCWSTR -> "buffer"
// lpGuid : LPCWSTR -> "buffer"
// pBuffer : void* optional, out -> "pointer"
// nSize : DWORD -> "u32"
// pdwAttribubutes : DWORD* optional, out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetFirmwareEnvironmentVariableExW(
    const uint16_t* lpName,
    const uint16_t* lpGuid,
    void* pBuffer,
    uint32_t nSize,
    uint32_t* pdwAttribubutes);
C, "KERNEL32.dll");
// $ffi->GetFirmwareEnvironmentVariableExW(lpName, lpGuid, pBuffer, nSize, pdwAttribubutes);
// lpName : LPCWSTR
// lpGuid : LPCWSTR
// pBuffer : void* optional, out
// nSize : DWORD
// pdwAttribubutes : DWORD* optional, out
// 構造体/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 GetFirmwareEnvironmentVariableExW(
        WString lpName,   // LPCWSTR
        WString lpGuid,   // LPCWSTR
        Pointer pBuffer,   // void* optional, out
        int nSize,   // DWORD
        IntByReference pdwAttribubutes   // DWORD* optional, out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun GetFirmwareEnvironmentVariableExW = GetFirmwareEnvironmentVariableExW(
    lpName : UInt16*,   # LPCWSTR
    lpGuid : UInt16*,   # LPCWSTR
    pBuffer : Void*,   # void* optional, out
    nSize : UInt32,   # DWORD
    pdwAttribubutes : UInt32*   # DWORD* optional, out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetFirmwareEnvironmentVariableExWNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>, Uint32, Pointer<Uint32>);
typedef GetFirmwareEnvironmentVariableExWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>, int, Pointer<Uint32>);
final GetFirmwareEnvironmentVariableExW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetFirmwareEnvironmentVariableExWNative, GetFirmwareEnvironmentVariableExWDart>('GetFirmwareEnvironmentVariableExW');
// lpName : LPCWSTR -> Pointer<Utf16>
// lpGuid : LPCWSTR -> Pointer<Utf16>
// pBuffer : void* optional, out -> Pointer<Void>
// nSize : DWORD -> Uint32
// pdwAttribubutes : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetFirmwareEnvironmentVariableExW(
  lpName: PWideChar;   // LPCWSTR
  lpGuid: PWideChar;   // LPCWSTR
  pBuffer: Pointer;   // void* optional, out
  nSize: DWORD;   // DWORD
  pdwAttribubutes: Pointer   // DWORD* optional, out
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetFirmwareEnvironmentVariableExW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let getfirmwareenvironmentvariableexw =
  foreign "GetFirmwareEnvironmentVariableExW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr void) @-> uint32_t @-> (ptr uint32_t) @-> returning uint32_t)
(* lpName : LPCWSTR -> (ptr uint16_t) *)
(* lpGuid : LPCWSTR -> (ptr uint16_t) *)
(* pBuffer : void* optional, out -> (ptr void) *)
(* nSize : DWORD -> uint32_t *)
(* pdwAttribubutes : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetFirmwareEnvironmentVariableExW" get-firmware-environment-variable-ex-w :convention :stdcall) :uint32
  (lp-name (:string :encoding :utf-16le))   ; LPCWSTR
  (lp-guid (:string :encoding :utf-16le))   ; LPCWSTR
  (p-buffer :pointer)   ; void* optional, out
  (n-size :uint32)   ; DWORD
  (pdw-attribubutes :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetFirmwareEnvironmentVariableExW = Win32::API::More->new('KERNEL32',
    'DWORD GetFirmwareEnvironmentVariableExW(LPCWSTR lpName, LPCWSTR lpGuid, LPVOID pBuffer, DWORD nSize, LPVOID pdwAttribubutes)');
# my $ret = $GetFirmwareEnvironmentVariableExW->Call($lpName, $lpGuid, $pBuffer, $nSize, $pdwAttribubutes);
# lpName : LPCWSTR -> LPCWSTR
# lpGuid : LPCWSTR -> LPCWSTR
# pBuffer : void* optional, out -> LPVOID
# nSize : DWORD -> DWORD
# pdwAttribubutes : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API