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

SetFirmwareEnvironmentVariableW

関数
ファームウェア環境変数の値をUnicodeで設定する。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL SetFirmwareEnvironmentVariableW(
    LPCWSTR lpName,
    LPCWSTR lpGuid,
    void* pValue,   // optional
    DWORD nSize
);

パラメーター

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

戻り値の型: BOOL

各言語での呼び出し定義

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

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

SetFirmwareEnvironmentVariableW = ctypes.windll.kernel32.SetFirmwareEnvironmentVariableW
SetFirmwareEnvironmentVariableW.restype = wintypes.BOOL
SetFirmwareEnvironmentVariableW.argtypes = [
    wintypes.LPCWSTR,  # lpName : LPCWSTR
    wintypes.LPCWSTR,  # lpGuid : LPCWSTR
    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')
SetFirmwareEnvironmentVariableW = Fiddle::Function.new(
  lib['SetFirmwareEnvironmentVariableW'],
  [
    Fiddle::TYPE_VOIDP,  # lpName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpGuid : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pValue : void* optional
    -Fiddle::TYPE_INT,  # nSize : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn SetFirmwareEnvironmentVariableW(
        lpName: *const u16,  // LPCWSTR
        lpGuid: *const u16,  // LPCWSTR
        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.Unicode, SetLastError = true)]
public static extern bool SetFirmwareEnvironmentVariableW([MarshalAs(UnmanagedType.LPWStr)] string lpName, [MarshalAs(UnmanagedType.LPWStr)] string lpGuid, IntPtr pValue, uint nSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetFirmwareEnvironmentVariableW' -Namespace Win32 -PassThru
# $api::SetFirmwareEnvironmentVariableW(lpName, lpGuid, pValue, nSize)
#uselib "KERNEL32.dll"
#func global SetFirmwareEnvironmentVariableW "SetFirmwareEnvironmentVariableW" wptr, wptr, wptr, wptr
; SetFirmwareEnvironmentVariableW lpName, lpGuid, pValue, nSize   ; 戻り値は stat
; lpName : LPCWSTR -> "wptr"
; lpGuid : LPCWSTR -> "wptr"
; pValue : void* optional -> "wptr"
; nSize : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetFirmwareEnvironmentVariableW "SetFirmwareEnvironmentVariableW" wstr, wstr, sptr, int
; res = SetFirmwareEnvironmentVariableW(lpName, lpGuid, pValue, nSize)
; lpName : LPCWSTR -> "wstr"
; lpGuid : LPCWSTR -> "wstr"
; pValue : void* optional -> "sptr"
; nSize : DWORD -> "int"
; BOOL SetFirmwareEnvironmentVariableW(LPCWSTR lpName, LPCWSTR lpGuid, void* pValue, DWORD nSize)
#uselib "KERNEL32.dll"
#cfunc global SetFirmwareEnvironmentVariableW "SetFirmwareEnvironmentVariableW" wstr, wstr, intptr, int
; res = SetFirmwareEnvironmentVariableW(lpName, lpGuid, pValue, nSize)
; lpName : LPCWSTR -> "wstr"
; lpGuid : LPCWSTR -> "wstr"
; pValue : void* optional -> "intptr"
; nSize : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetFirmwareEnvironmentVariableW = kernel32.NewProc("SetFirmwareEnvironmentVariableW")
)

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

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

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

let setfirmwareenvironmentvariablew =
  foreign "SetFirmwareEnvironmentVariableW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* lpName : LPCWSTR -> (ptr uint16_t) *)
(* lpGuid : LPCWSTR -> (ptr uint16_t) *)
(* 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 ("SetFirmwareEnvironmentVariableW" set-firmware-environment-variable-w :convention :stdcall) :int32
  (lp-name (:string :encoding :utf-16le))   ; LPCWSTR
  (lp-guid (:string :encoding :utf-16le))   ; LPCWSTR
  (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 $SetFirmwareEnvironmentVariableW = Win32::API::More->new('KERNEL32',
    'BOOL SetFirmwareEnvironmentVariableW(LPCWSTR lpName, LPCWSTR lpGuid, LPVOID pValue, DWORD nSize)');
# my $ret = $SetFirmwareEnvironmentVariableW->Call($lpName, $lpGuid, $pValue, $nSize);
# lpName : LPCWSTR -> LPCWSTR
# lpGuid : LPCWSTR -> LPCWSTR
# pValue : void* optional -> LPVOID
# nSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API