ホーム › System.WindowsProgramming › GetFirmwareEnvironmentVariableExA
GetFirmwareEnvironmentVariableExA
関数属性付きでファームウェア環境変数の値をANSIで取得する。
シグネチャ
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
DWORD GetFirmwareEnvironmentVariableExA(
LPCSTR lpName,
LPCSTR lpGuid,
void* pBuffer, // optional
DWORD nSize,
DWORD* pdwAttribubutes // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| lpName | LPCSTR | in | 取得するファームウェア環境変数の名前(ANSI文字列)。 |
| lpGuid | LPCSTR | in | 変数が属する名前空間を表すGUID文字列(ANSI)。 |
| pBuffer | void* | outoptional | 取得した変数値を格納するバッファへのポインタ。 |
| nSize | DWORD | in | バッファpBufferのサイズ(バイト数)。 |
| pdwAttribubutes | DWORD* | outoptional | 変数の属性ビット(揮発性/ブート時アクセス等)を受け取る出力ポインタ。 |
戻り値の型: DWORD
各言語での呼び出し定義
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
DWORD GetFirmwareEnvironmentVariableExA(
LPCSTR lpName,
LPCSTR lpGuid,
void* pBuffer, // optional
DWORD nSize,
DWORD* pdwAttribubutes // optional
);[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern uint GetFirmwareEnvironmentVariableExA(
[MarshalAs(UnmanagedType.LPStr)] string lpName, // LPCSTR
[MarshalAs(UnmanagedType.LPStr)] string lpGuid, // LPCSTR
IntPtr pBuffer, // void* optional, out
uint nSize, // DWORD
IntPtr pdwAttribubutes // DWORD* optional, out
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetFirmwareEnvironmentVariableExA(
<MarshalAs(UnmanagedType.LPStr)> lpName As String, ' LPCSTR
<MarshalAs(UnmanagedType.LPStr)> lpGuid As String, ' LPCSTR
pBuffer As IntPtr, ' void* optional, out
nSize As UInteger, ' DWORD
pdwAttribubutes As IntPtr ' DWORD* optional, out
) As UInteger
End Function' lpName : LPCSTR
' lpGuid : LPCSTR
' pBuffer : void* optional, out
' nSize : DWORD
' pdwAttribubutes : DWORD* optional, out
Declare PtrSafe Function GetFirmwareEnvironmentVariableExA Lib "kernel32" ( _
ByVal lpName As String, _
ByVal lpGuid As String, _
ByVal pBuffer As LongPtr, _
ByVal nSize As Long, _
ByVal pdwAttribubutes As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
GetFirmwareEnvironmentVariableExA = ctypes.windll.kernel32.GetFirmwareEnvironmentVariableExA
GetFirmwareEnvironmentVariableExA.restype = wintypes.DWORD
GetFirmwareEnvironmentVariableExA.argtypes = [
wintypes.LPCSTR, # lpName : LPCSTR
wintypes.LPCSTR, # lpGuid : LPCSTR
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')
GetFirmwareEnvironmentVariableExA = Fiddle::Function.new(
lib['GetFirmwareEnvironmentVariableExA'],
[
Fiddle::TYPE_VOIDP, # lpName : LPCSTR
Fiddle::TYPE_VOIDP, # lpGuid : LPCSTR
Fiddle::TYPE_VOIDP, # pBuffer : void* optional, out
-Fiddle::TYPE_INT, # nSize : DWORD
Fiddle::TYPE_VOIDP, # pdwAttribubutes : DWORD* optional, out
],
-Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn GetFirmwareEnvironmentVariableExA(
lpName: *const u8, // LPCSTR
lpGuid: *const u8, // LPCSTR
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.Ansi, SetLastError = true)]
public static extern uint GetFirmwareEnvironmentVariableExA([MarshalAs(UnmanagedType.LPStr)] string lpName, [MarshalAs(UnmanagedType.LPStr)] string lpGuid, IntPtr pBuffer, uint nSize, IntPtr pdwAttribubutes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetFirmwareEnvironmentVariableExA' -Namespace Win32 -PassThru
# $api::GetFirmwareEnvironmentVariableExA(lpName, lpGuid, pBuffer, nSize, pdwAttribubutes)#uselib "KERNEL32.dll"
#func global GetFirmwareEnvironmentVariableExA "GetFirmwareEnvironmentVariableExA" sptr, sptr, sptr, sptr, sptr
; GetFirmwareEnvironmentVariableExA lpName, lpGuid, pBuffer, nSize, varptr(pdwAttribubutes) ; 戻り値は stat
; lpName : LPCSTR -> "sptr"
; lpGuid : LPCSTR -> "sptr"
; pBuffer : void* optional, out -> "sptr"
; nSize : DWORD -> "sptr"
; pdwAttribubutes : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "KERNEL32.dll" #cfunc global GetFirmwareEnvironmentVariableExA "GetFirmwareEnvironmentVariableExA" str, str, sptr, int, var ; res = GetFirmwareEnvironmentVariableExA(lpName, lpGuid, pBuffer, nSize, pdwAttribubutes) ; lpName : LPCSTR -> "str" ; lpGuid : LPCSTR -> "str" ; pBuffer : void* optional, out -> "sptr" ; nSize : DWORD -> "int" ; pdwAttribubutes : DWORD* optional, out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll" #cfunc global GetFirmwareEnvironmentVariableExA "GetFirmwareEnvironmentVariableExA" str, str, sptr, int, sptr ; res = GetFirmwareEnvironmentVariableExA(lpName, lpGuid, pBuffer, nSize, varptr(pdwAttribubutes)) ; lpName : LPCSTR -> "str" ; lpGuid : LPCSTR -> "str" ; pBuffer : void* optional, out -> "sptr" ; nSize : DWORD -> "int" ; pdwAttribubutes : DWORD* optional, out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; DWORD GetFirmwareEnvironmentVariableExA(LPCSTR lpName, LPCSTR lpGuid, void* pBuffer, DWORD nSize, DWORD* pdwAttribubutes) #uselib "KERNEL32.dll" #cfunc global GetFirmwareEnvironmentVariableExA "GetFirmwareEnvironmentVariableExA" str, str, intptr, int, var ; res = GetFirmwareEnvironmentVariableExA(lpName, lpGuid, pBuffer, nSize, pdwAttribubutes) ; lpName : LPCSTR -> "str" ; lpGuid : LPCSTR -> "str" ; pBuffer : void* optional, out -> "intptr" ; nSize : DWORD -> "int" ; pdwAttribubutes : DWORD* optional, out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD GetFirmwareEnvironmentVariableExA(LPCSTR lpName, LPCSTR lpGuid, void* pBuffer, DWORD nSize, DWORD* pdwAttribubutes) #uselib "KERNEL32.dll" #cfunc global GetFirmwareEnvironmentVariableExA "GetFirmwareEnvironmentVariableExA" str, str, intptr, int, intptr ; res = GetFirmwareEnvironmentVariableExA(lpName, lpGuid, pBuffer, nSize, varptr(pdwAttribubutes)) ; lpName : LPCSTR -> "str" ; lpGuid : LPCSTR -> "str" ; pBuffer : void* optional, out -> "intptr" ; nSize : DWORD -> "int" ; pdwAttribubutes : DWORD* optional, out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procGetFirmwareEnvironmentVariableExA = kernel32.NewProc("GetFirmwareEnvironmentVariableExA")
)
// lpName (LPCSTR), lpGuid (LPCSTR), pBuffer (void* optional, out), nSize (DWORD), pdwAttribubutes (DWORD* optional, out)
r1, _, err := procGetFirmwareEnvironmentVariableExA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpName))),
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpGuid))),
uintptr(pBuffer),
uintptr(nSize),
uintptr(pdwAttribubutes),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction GetFirmwareEnvironmentVariableExA(
lpName: PAnsiChar; // LPCSTR
lpGuid: PAnsiChar; // LPCSTR
pBuffer: Pointer; // void* optional, out
nSize: DWORD; // DWORD
pdwAttribubutes: Pointer // DWORD* optional, out
): DWORD; stdcall;
external 'KERNEL32.dll' name 'GetFirmwareEnvironmentVariableExA';result := DllCall("KERNEL32\GetFirmwareEnvironmentVariableExA"
, "AStr", lpName ; LPCSTR
, "AStr", lpGuid ; LPCSTR
, "Ptr", pBuffer ; void* optional, out
, "UInt", nSize ; DWORD
, "Ptr", pdwAttribubutes ; DWORD* optional, out
, "UInt") ; return: DWORD●GetFirmwareEnvironmentVariableExA(lpName, lpGuid, pBuffer, nSize, pdwAttribubutes) = DLL("KERNEL32.dll", "dword GetFirmwareEnvironmentVariableExA(char*, char*, void*, dword, void*)")
# 呼び出し: GetFirmwareEnvironmentVariableExA(lpName, lpGuid, pBuffer, nSize, pdwAttribubutes)
# lpName : LPCSTR -> "char*"
# lpGuid : LPCSTR -> "char*"
# pBuffer : void* optional, out -> "void*"
# nSize : DWORD -> "dword"
# pdwAttribubutes : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn GetFirmwareEnvironmentVariableExA(
lpName: [*c]const u8, // LPCSTR
lpGuid: [*c]const u8, // LPCSTR
pBuffer: ?*anyopaque, // void* optional, out
nSize: u32, // DWORD
pdwAttribubutes: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) u32;proc GetFirmwareEnvironmentVariableExA(
lpName: cstring, # LPCSTR
lpGuid: cstring, # LPCSTR
pBuffer: pointer, # void* optional, out
nSize: uint32, # DWORD
pdwAttribubutes: ptr uint32 # DWORD* optional, out
): uint32 {.importc: "GetFirmwareEnvironmentVariableExA", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
uint GetFirmwareEnvironmentVariableExA(
const(char)* lpName, // LPCSTR
const(char)* lpGuid, // LPCSTR
void* pBuffer, // void* optional, out
uint nSize, // DWORD
uint* pdwAttribubutes // DWORD* optional, out
);ccall((:GetFirmwareEnvironmentVariableExA, "KERNEL32.dll"), stdcall, UInt32,
(Cstring, Cstring, Ptr{Cvoid}, UInt32, Ptr{UInt32}),
lpName, lpGuid, pBuffer, nSize, pdwAttribubutes)
# lpName : LPCSTR -> Cstring
# lpGuid : LPCSTR -> Cstring
# pBuffer : void* optional, out -> Ptr{Cvoid}
# nSize : DWORD -> UInt32
# pdwAttribubutes : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t GetFirmwareEnvironmentVariableExA(
const char* lpName,
const char* lpGuid,
void* pBuffer,
uint32_t nSize,
uint32_t* pdwAttribubutes);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetFirmwareEnvironmentVariableExA(lpName, lpGuid, pBuffer, nSize, pdwAttribubutes)
-- lpName : LPCSTR
-- lpGuid : LPCSTR
-- pBuffer : void* optional, out
-- nSize : DWORD
-- pdwAttribubutes : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetFirmwareEnvironmentVariableExA = lib.func('__stdcall', 'GetFirmwareEnvironmentVariableExA', 'uint32_t', ['str', 'str', 'void *', 'uint32_t', 'uint32_t *']);
// GetFirmwareEnvironmentVariableExA(lpName, lpGuid, pBuffer, nSize, pdwAttribubutes)
// lpName : LPCSTR -> 'str'
// lpGuid : LPCSTR -> 'str'
// 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", {
GetFirmwareEnvironmentVariableExA: { parameters: ["buffer", "buffer", "pointer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.GetFirmwareEnvironmentVariableExA(lpName, lpGuid, pBuffer, nSize, pdwAttribubutes)
// lpName : LPCSTR -> "buffer"
// lpGuid : LPCSTR -> "buffer"
// pBuffer : void* optional, out -> "pointer"
// nSize : DWORD -> "u32"
// pdwAttribubutes : DWORD* optional, out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t GetFirmwareEnvironmentVariableExA(
const char* lpName,
const char* lpGuid,
void* pBuffer,
uint32_t nSize,
uint32_t* pdwAttribubutes);
C, "KERNEL32.dll");
// $ffi->GetFirmwareEnvironmentVariableExA(lpName, lpGuid, pBuffer, nSize, pdwAttribubutes);
// lpName : LPCSTR
// lpGuid : LPCSTR
// 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.ASCII_OPTIONS);
int GetFirmwareEnvironmentVariableExA(
String lpName, // LPCSTR
String lpGuid, // LPCSTR
Pointer pBuffer, // void* optional, out
int nSize, // DWORD
IntByReference pdwAttribubutes // DWORD* optional, out
);
}@[Link("kernel32")]
lib LibKERNEL32
fun GetFirmwareEnvironmentVariableExA = GetFirmwareEnvironmentVariableExA(
lpName : UInt8*, # LPCSTR
lpGuid : UInt8*, # LPCSTR
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 GetFirmwareEnvironmentVariableExANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>, Uint32, Pointer<Uint32>);
typedef GetFirmwareEnvironmentVariableExADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>, int, Pointer<Uint32>);
final GetFirmwareEnvironmentVariableExA = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<GetFirmwareEnvironmentVariableExANative, GetFirmwareEnvironmentVariableExADart>('GetFirmwareEnvironmentVariableExA');
// lpName : LPCSTR -> Pointer<Utf8>
// lpGuid : LPCSTR -> Pointer<Utf8>
// pBuffer : void* optional, out -> Pointer<Void>
// nSize : DWORD -> Uint32
// pdwAttribubutes : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function GetFirmwareEnvironmentVariableExA(
lpName: PAnsiChar; // LPCSTR
lpGuid: PAnsiChar; // LPCSTR
pBuffer: Pointer; // void* optional, out
nSize: DWORD; // DWORD
pdwAttribubutes: Pointer // DWORD* optional, out
): DWORD; stdcall;
external 'KERNEL32.dll' name 'GetFirmwareEnvironmentVariableExA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GetFirmwareEnvironmentVariableExA"
c_GetFirmwareEnvironmentVariableExA :: CString -> CString -> Ptr () -> Word32 -> Ptr Word32 -> IO Word32
-- lpName : LPCSTR -> CString
-- lpGuid : LPCSTR -> CString
-- 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 getfirmwareenvironmentvariableexa =
foreign "GetFirmwareEnvironmentVariableExA"
(string @-> string @-> (ptr void) @-> uint32_t @-> (ptr uint32_t) @-> returning uint32_t)
(* lpName : LPCSTR -> string *)
(* lpGuid : LPCSTR -> string *)
(* 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 ("GetFirmwareEnvironmentVariableExA" get-firmware-environment-variable-ex-a :convention :stdcall) :uint32
(lp-name :string) ; LPCSTR
(lp-guid :string) ; LPCSTR
(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 $GetFirmwareEnvironmentVariableExA = Win32::API::More->new('KERNEL32',
'DWORD GetFirmwareEnvironmentVariableExA(LPCSTR lpName, LPCSTR lpGuid, LPVOID pBuffer, DWORD nSize, LPVOID pdwAttribubutes)');
# my $ret = $GetFirmwareEnvironmentVariableExA->Call($lpName, $lpGuid, $pBuffer, $nSize, $pdwAttribubutes);
# lpName : LPCSTR -> LPCSTR
# lpGuid : LPCSTR -> LPCSTR
# pBuffer : void* optional, out -> LPVOID
# nSize : DWORD -> DWORD
# pdwAttribubutes : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f GetFirmwareEnvironmentVariableExW (Unicode版) — 属性付きでファームウェア環境変数の値をUnicodeで取得する。
類似 API
- f GetFirmwareEnvironmentVariableA — ファームウェア環境変数の値をANSIで取得する。