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
pValuevoid*inoptional
nSizeDWORDin

戻り値の型: 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 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 版の利用を推奨。