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

SetFirmwareEnvironmentVariableA

関数
ファームウェア環境変数の値をANSIで設定する。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

BOOL SetFirmwareEnvironmentVariableA(
    LPCSTR lpName,
    LPCSTR lpGuid,
    void* pValue,   // optional
    DWORD nSize
);

パラメーター

名前型方向説明
lpNameLPCSTRin設定するファームウェア環境変数の名前(ANSI文字列)。
lpGuidLPCSTRin変数が属する名前空間を表すGUID文字列(ANSI)。
pValuevoid*inoptional設定する変数値が入ったバッファへのポインタ。NULL/サイズ0で削除。
nSizeDWORDin値pValueのサイズ(バイト数)。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SetFirmwareEnvironmentVariableA(
    LPCSTR lpName,
    LPCSTR lpGuid,
    void* pValue,   // optional
    DWORD nSize
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetFirmwareEnvironmentVariableA(
    [MarshalAs(UnmanagedType.LPStr)] string lpName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpGuid,   // LPCSTR
    IntPtr pValue,   // void* optional
    uint nSize   // DWORD
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetFirmwareEnvironmentVariableA(
    <MarshalAs(UnmanagedType.LPStr)> lpName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpGuid As String,   ' LPCSTR
    pValue As IntPtr,   ' void* optional
    nSize As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpName : LPCSTR
' lpGuid : LPCSTR
' pValue : void* optional
' nSize : DWORD
Declare PtrSafe Function SetFirmwareEnvironmentVariableA Lib "kernel32" ( _
    ByVal lpName As String, _
    ByVal lpGuid As String, _
    ByVal pValue As LongPtr, _
    ByVal nSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetFirmwareEnvironmentVariableA = ctypes.windll.kernel32.SetFirmwareEnvironmentVariableA
SetFirmwareEnvironmentVariableA.restype = wintypes.BOOL
SetFirmwareEnvironmentVariableA.argtypes = [
    wintypes.LPCSTR,  # lpName : LPCSTR
    wintypes.LPCSTR,  # lpGuid : LPCSTR
    ctypes.POINTER(None),  # pValue : void* optional
    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')
SetFirmwareEnvironmentVariableA = Fiddle::Function.new(
  lib['SetFirmwareEnvironmentVariableA'],
  [
    Fiddle::TYPE_VOIDP,  # lpName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpGuid : LPCSTR
    Fiddle::TYPE_VOIDP,  # pValue : void* optional
    -Fiddle::TYPE_INT,  # nSize : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetFirmwareEnvironmentVariableA(
        lpName: *const u8,  // LPCSTR
        lpGuid: *const u8,  // LPCSTR
        pValue: *mut (),  // void* optional
        nSize: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool SetFirmwareEnvironmentVariableA([MarshalAs(UnmanagedType.LPStr)] string lpName, [MarshalAs(UnmanagedType.LPStr)] string lpGuid, IntPtr pValue, uint nSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetFirmwareEnvironmentVariableA' -Namespace Win32 -PassThru
# $api::SetFirmwareEnvironmentVariableA(lpName, lpGuid, pValue, nSize)
#uselib "KERNEL32.dll"
#func global SetFirmwareEnvironmentVariableA "SetFirmwareEnvironmentVariableA" sptr, sptr, sptr, sptr
; SetFirmwareEnvironmentVariableA lpName, lpGuid, pValue, nSize   ; 戻り値は stat
; lpName : LPCSTR -> "sptr"
; lpGuid : LPCSTR -> "sptr"
; pValue : void* optional -> "sptr"
; nSize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetFirmwareEnvironmentVariableA "SetFirmwareEnvironmentVariableA" str, str, sptr, int
; res = SetFirmwareEnvironmentVariableA(lpName, lpGuid, pValue, nSize)
; lpName : LPCSTR -> "str"
; lpGuid : LPCSTR -> "str"
; pValue : void* optional -> "sptr"
; nSize : DWORD -> "int"
; BOOL SetFirmwareEnvironmentVariableA(LPCSTR lpName, LPCSTR lpGuid, void* pValue, DWORD nSize)
#uselib "KERNEL32.dll"
#cfunc global SetFirmwareEnvironmentVariableA "SetFirmwareEnvironmentVariableA" str, str, intptr, int
; res = SetFirmwareEnvironmentVariableA(lpName, lpGuid, pValue, nSize)
; lpName : LPCSTR -> "str"
; lpGuid : LPCSTR -> "str"
; pValue : void* optional -> "intptr"
; nSize : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetFirmwareEnvironmentVariableA = kernel32.NewProc("SetFirmwareEnvironmentVariableA")
)

// lpName (LPCSTR), lpGuid (LPCSTR), pValue (void* optional), nSize (DWORD)
r1, _, err := procSetFirmwareEnvironmentVariableA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpGuid))),
	uintptr(pValue),
	uintptr(nSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetFirmwareEnvironmentVariableA(
  lpName: PAnsiChar;   // LPCSTR
  lpGuid: PAnsiChar;   // LPCSTR
  pValue: Pointer;   // void* optional
  nSize: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetFirmwareEnvironmentVariableA';
result := DllCall("KERNEL32\SetFirmwareEnvironmentVariableA"
    , "AStr", lpName   ; LPCSTR
    , "AStr", lpGuid   ; LPCSTR
    , "Ptr", pValue   ; void* optional
    , "UInt", nSize   ; DWORD
    , "Int")   ; return: BOOL
●SetFirmwareEnvironmentVariableA(lpName, lpGuid, pValue, nSize) = DLL("KERNEL32.dll", "bool SetFirmwareEnvironmentVariableA(char*, char*, void*, dword)")
# 呼び出し: SetFirmwareEnvironmentVariableA(lpName, lpGuid, pValue, nSize)
# lpName : LPCSTR -> "char*"
# lpGuid : LPCSTR -> "char*"
# pValue : void* optional -> "void*"
# nSize : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn SetFirmwareEnvironmentVariableA(
    lpName: [*c]const u8, // LPCSTR
    lpGuid: [*c]const u8, // LPCSTR
    pValue: ?*anyopaque, // void* optional
    nSize: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc SetFirmwareEnvironmentVariableA(
    lpName: cstring,  # LPCSTR
    lpGuid: cstring,  # LPCSTR
    pValue: pointer,  # void* optional
    nSize: uint32  # DWORD
): int32 {.importc: "SetFirmwareEnvironmentVariableA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int SetFirmwareEnvironmentVariableA(
    const(char)* lpName,   // LPCSTR
    const(char)* lpGuid,   // LPCSTR
    void* pValue,   // void* optional
    uint nSize   // DWORD
);
ccall((:SetFirmwareEnvironmentVariableA, "KERNEL32.dll"), stdcall, Int32,
      (Cstring, Cstring, Ptr{Cvoid}, UInt32),
      lpName, lpGuid, pValue, nSize)
# lpName : LPCSTR -> Cstring
# lpGuid : LPCSTR -> Cstring
# pValue : void* optional -> Ptr{Cvoid}
# nSize : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetFirmwareEnvironmentVariableA(
    const char* lpName,
    const char* lpGuid,
    void* pValue,
    uint32_t nSize);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetFirmwareEnvironmentVariableA(lpName, lpGuid, pValue, nSize)
-- lpName : LPCSTR
-- lpGuid : LPCSTR
-- pValue : void* optional
-- nSize : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetFirmwareEnvironmentVariableA = lib.func('__stdcall', 'SetFirmwareEnvironmentVariableA', 'int32_t', ['str', 'str', 'void *', 'uint32_t']);
// SetFirmwareEnvironmentVariableA(lpName, lpGuid, pValue, nSize)
// lpName : LPCSTR -> 'str'
// lpGuid : LPCSTR -> 'str'
// pValue : void* optional -> 'void *'
// nSize : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetFirmwareEnvironmentVariableA: { parameters: ["buffer", "buffer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.SetFirmwareEnvironmentVariableA(lpName, lpGuid, pValue, nSize)
// lpName : LPCSTR -> "buffer"
// lpGuid : LPCSTR -> "buffer"
// pValue : void* optional -> "pointer"
// nSize : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetFirmwareEnvironmentVariableA(
    const char* lpName,
    const char* lpGuid,
    void* pValue,
    uint32_t nSize);
C, "KERNEL32.dll");
// $ffi->SetFirmwareEnvironmentVariableA(lpName, lpGuid, pValue, nSize);
// lpName : LPCSTR
// lpGuid : LPCSTR
// pValue : void* optional
// 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.ASCII_OPTIONS);
    boolean SetFirmwareEnvironmentVariableA(
        String lpName,   // LPCSTR
        String lpGuid,   // LPCSTR
        Pointer pValue,   // void* optional
        int nSize   // DWORD
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun SetFirmwareEnvironmentVariableA = SetFirmwareEnvironmentVariableA(
    lpName : UInt8*,   # LPCSTR
    lpGuid : UInt8*,   # LPCSTR
    pValue : Void*,   # void* optional
    nSize : 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 SetFirmwareEnvironmentVariableANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>, Uint32);
typedef SetFirmwareEnvironmentVariableADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>, int);
final SetFirmwareEnvironmentVariableA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetFirmwareEnvironmentVariableANative, SetFirmwareEnvironmentVariableADart>('SetFirmwareEnvironmentVariableA');
// lpName : LPCSTR -> Pointer<Utf8>
// lpGuid : LPCSTR -> Pointer<Utf8>
// pValue : void* optional -> Pointer<Void>
// nSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetFirmwareEnvironmentVariableA(
  lpName: PAnsiChar;   // LPCSTR
  lpGuid: PAnsiChar;   // LPCSTR
  pValue: Pointer;   // void* optional
  nSize: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetFirmwareEnvironmentVariableA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetFirmwareEnvironmentVariableA"
  c_SetFirmwareEnvironmentVariableA :: CString -> CString -> Ptr () -> Word32 -> IO CInt
-- lpName : LPCSTR -> CString
-- lpGuid : LPCSTR -> CString
-- pValue : void* optional -> Ptr ()
-- nSize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setfirmwareenvironmentvariablea =
  foreign "SetFirmwareEnvironmentVariableA"
    (string @-> string @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* lpName : LPCSTR -> string *)
(* lpGuid : LPCSTR -> string *)
(* pValue : void* optional -> (ptr void) *)
(* 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 ("SetFirmwareEnvironmentVariableA" set-firmware-environment-variable-a :convention :stdcall) :int32
  (lp-name :string)   ; LPCSTR
  (lp-guid :string)   ; LPCSTR
  (p-value :pointer)   ; void* optional
  (n-size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetFirmwareEnvironmentVariableA = Win32::API::More->new('KERNEL32',
    'BOOL SetFirmwareEnvironmentVariableA(LPCSTR lpName, LPCSTR lpGuid, LPVOID pValue, DWORD nSize)');
# my $ret = $SetFirmwareEnvironmentVariableA->Call($lpName, $lpGuid, $pValue, $nSize);
# lpName : LPCSTR -> LPCSTR
# lpGuid : LPCSTR -> LPCSTR
# pValue : void* optional -> LPVOID
# nSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
類似 API