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

GetFirmwareEnvironmentVariableExA

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

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

DWORD GetFirmwareEnvironmentVariableExA(
    LPCSTR lpName,
    LPCSTR lpGuid,
    void* pBuffer,   // optional
    DWORD nSize,
    DWORD* pdwAttribubutes   // optional
);

パラメーター

名前方向
lpNameLPCSTRin
lpGuidLPCSTRin
pBuffervoid*outoptional
nSizeDWORDin
pdwAttribubutesDWORD*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 方式にも切替可。
出力引数:
; 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 方式にも切替可。
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   // DWORD
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';
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)。