ホーム › System.WindowsProgramming › SetFirmwareEnvironmentVariableExW
SetFirmwareEnvironmentVariableExW
関数属性付きでファームウェア環境変数の値をUnicodeで設定する。
シグネチャ
// KERNEL32.dll (Unicode / -W)
#include <windows.h>
BOOL SetFirmwareEnvironmentVariableExW(
LPCWSTR lpName,
LPCWSTR lpGuid,
void* pValue, // optional
DWORD nSize,
DWORD dwAttributes
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| lpName | LPCWSTR | in | 設定するファームウェア環境変数の名前(ワイド文字列)。 |
| lpGuid | LPCWSTR | in | 変数が属する名前空間を表すGUID文字列(ワイド)。 |
| pValue | void* | inoptional | 設定する変数値が入ったバッファへのポインタ。NULL/サイズ0で削除。 |
| nSize | DWORD | in | 値pValueのサイズ(バイト数)。 |
| dwAttributes | DWORD | in | 設定する変数の属性ビット(揮発性/不揮発/ブート時アクセス等)。 |
戻り値の型: BOOL
各言語での呼び出し定義
// KERNEL32.dll (Unicode / -W)
#include <windows.h>
BOOL SetFirmwareEnvironmentVariableExW(
LPCWSTR lpName,
LPCWSTR lpGuid,
void* pValue, // optional
DWORD nSize,
DWORD dwAttributes
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetFirmwareEnvironmentVariableExW(
[MarshalAs(UnmanagedType.LPWStr)] string lpName, // LPCWSTR
[MarshalAs(UnmanagedType.LPWStr)] string lpGuid, // LPCWSTR
IntPtr pValue, // void* optional
uint nSize, // DWORD
uint dwAttributes // DWORD
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetFirmwareEnvironmentVariableExW(
<MarshalAs(UnmanagedType.LPWStr)> lpName As String, ' LPCWSTR
<MarshalAs(UnmanagedType.LPWStr)> lpGuid As String, ' LPCWSTR
pValue As IntPtr, ' void* optional
nSize As UInteger, ' DWORD
dwAttributes As UInteger ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' lpName : LPCWSTR
' lpGuid : LPCWSTR
' pValue : void* optional
' nSize : DWORD
' dwAttributes : DWORD
Declare PtrSafe Function SetFirmwareEnvironmentVariableExW Lib "kernel32" ( _
ByVal lpName As LongPtr, _
ByVal lpGuid As LongPtr, _
ByVal pValue As LongPtr, _
ByVal nSize As Long, _
ByVal dwAttributes 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
SetFirmwareEnvironmentVariableExW = ctypes.windll.kernel32.SetFirmwareEnvironmentVariableExW
SetFirmwareEnvironmentVariableExW.restype = wintypes.BOOL
SetFirmwareEnvironmentVariableExW.argtypes = [
wintypes.LPCWSTR, # lpName : LPCWSTR
wintypes.LPCWSTR, # lpGuid : LPCWSTR
ctypes.POINTER(None), # pValue : void* optional
wintypes.DWORD, # nSize : DWORD
wintypes.DWORD, # dwAttributes : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
SetFirmwareEnvironmentVariableExW = Fiddle::Function.new(
lib['SetFirmwareEnvironmentVariableExW'],
[
Fiddle::TYPE_VOIDP, # lpName : LPCWSTR
Fiddle::TYPE_VOIDP, # lpGuid : LPCWSTR
Fiddle::TYPE_VOIDP, # pValue : void* optional
-Fiddle::TYPE_INT, # nSize : DWORD
-Fiddle::TYPE_INT, # dwAttributes : DWORD
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "kernel32")]
extern "system" {
fn SetFirmwareEnvironmentVariableExW(
lpName: *const u16, // LPCWSTR
lpGuid: *const u16, // LPCWSTR
pValue: *mut (), // void* optional
nSize: u32, // DWORD
dwAttributes: 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 SetFirmwareEnvironmentVariableExW([MarshalAs(UnmanagedType.LPWStr)] string lpName, [MarshalAs(UnmanagedType.LPWStr)] string lpGuid, IntPtr pValue, uint nSize, uint dwAttributes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetFirmwareEnvironmentVariableExW' -Namespace Win32 -PassThru
# $api::SetFirmwareEnvironmentVariableExW(lpName, lpGuid, pValue, nSize, dwAttributes)#uselib "KERNEL32.dll"
#func global SetFirmwareEnvironmentVariableExW "SetFirmwareEnvironmentVariableExW" wptr, wptr, wptr, wptr, wptr
; SetFirmwareEnvironmentVariableExW lpName, lpGuid, pValue, nSize, dwAttributes ; 戻り値は stat
; lpName : LPCWSTR -> "wptr"
; lpGuid : LPCWSTR -> "wptr"
; pValue : void* optional -> "wptr"
; nSize : DWORD -> "wptr"
; dwAttributes : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global SetFirmwareEnvironmentVariableExW "SetFirmwareEnvironmentVariableExW" wstr, wstr, sptr, int, int
; res = SetFirmwareEnvironmentVariableExW(lpName, lpGuid, pValue, nSize, dwAttributes)
; lpName : LPCWSTR -> "wstr"
; lpGuid : LPCWSTR -> "wstr"
; pValue : void* optional -> "sptr"
; nSize : DWORD -> "int"
; dwAttributes : DWORD -> "int"; BOOL SetFirmwareEnvironmentVariableExW(LPCWSTR lpName, LPCWSTR lpGuid, void* pValue, DWORD nSize, DWORD dwAttributes)
#uselib "KERNEL32.dll"
#cfunc global SetFirmwareEnvironmentVariableExW "SetFirmwareEnvironmentVariableExW" wstr, wstr, intptr, int, int
; res = SetFirmwareEnvironmentVariableExW(lpName, lpGuid, pValue, nSize, dwAttributes)
; lpName : LPCWSTR -> "wstr"
; lpGuid : LPCWSTR -> "wstr"
; pValue : void* optional -> "intptr"
; nSize : DWORD -> "int"
; dwAttributes : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procSetFirmwareEnvironmentVariableExW = kernel32.NewProc("SetFirmwareEnvironmentVariableExW")
)
// lpName (LPCWSTR), lpGuid (LPCWSTR), pValue (void* optional), nSize (DWORD), dwAttributes (DWORD)
r1, _, err := procSetFirmwareEnvironmentVariableExW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpName))),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpGuid))),
uintptr(pValue),
uintptr(nSize),
uintptr(dwAttributes),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction SetFirmwareEnvironmentVariableExW(
lpName: PWideChar; // LPCWSTR
lpGuid: PWideChar; // LPCWSTR
pValue: Pointer; // void* optional
nSize: DWORD; // DWORD
dwAttributes: DWORD // DWORD
): BOOL; stdcall;
external 'KERNEL32.dll' name 'SetFirmwareEnvironmentVariableExW';result := DllCall("KERNEL32\SetFirmwareEnvironmentVariableExW"
, "WStr", lpName ; LPCWSTR
, "WStr", lpGuid ; LPCWSTR
, "Ptr", pValue ; void* optional
, "UInt", nSize ; DWORD
, "UInt", dwAttributes ; DWORD
, "Int") ; return: BOOL●SetFirmwareEnvironmentVariableExW(lpName, lpGuid, pValue, nSize, dwAttributes) = DLL("KERNEL32.dll", "bool SetFirmwareEnvironmentVariableExW(char*, char*, void*, dword, dword)")
# 呼び出し: SetFirmwareEnvironmentVariableExW(lpName, lpGuid, pValue, nSize, dwAttributes)
# lpName : LPCWSTR -> "char*"
# lpGuid : LPCWSTR -> "char*"
# pValue : void* optional -> "void*"
# nSize : DWORD -> "dword"
# dwAttributes : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "kernel32" fn SetFirmwareEnvironmentVariableExW(
lpName: [*c]const u16, // LPCWSTR
lpGuid: [*c]const u16, // LPCWSTR
pValue: ?*anyopaque, // void* optional
nSize: u32, // DWORD
dwAttributes: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc SetFirmwareEnvironmentVariableExW(
lpName: WideCString, # LPCWSTR
lpGuid: WideCString, # LPCWSTR
pValue: pointer, # void* optional
nSize: uint32, # DWORD
dwAttributes: uint32 # DWORD
): int32 {.importc: "SetFirmwareEnvironmentVariableExW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "kernel32");
extern(Windows)
int SetFirmwareEnvironmentVariableExW(
const(wchar)* lpName, // LPCWSTR
const(wchar)* lpGuid, // LPCWSTR
void* pValue, // void* optional
uint nSize, // DWORD
uint dwAttributes // DWORD
);ccall((:SetFirmwareEnvironmentVariableExW, "KERNEL32.dll"), stdcall, Int32,
(Cwstring, Cwstring, Ptr{Cvoid}, UInt32, UInt32),
lpName, lpGuid, pValue, nSize, dwAttributes)
# lpName : LPCWSTR -> Cwstring
# lpGuid : LPCWSTR -> Cwstring
# pValue : void* optional -> Ptr{Cvoid}
# nSize : DWORD -> UInt32
# dwAttributes : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t SetFirmwareEnvironmentVariableExW(
const uint16_t* lpName,
const uint16_t* lpGuid,
void* pValue,
uint32_t nSize,
uint32_t dwAttributes);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetFirmwareEnvironmentVariableExW(lpName, lpGuid, pValue, nSize, dwAttributes)
-- lpName : LPCWSTR
-- lpGuid : LPCWSTR
-- pValue : void* optional
-- nSize : DWORD
-- dwAttributes : 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 SetFirmwareEnvironmentVariableExW = lib.func('__stdcall', 'SetFirmwareEnvironmentVariableExW', 'int32_t', ['str16', 'str16', 'void *', 'uint32_t', 'uint32_t']);
// SetFirmwareEnvironmentVariableExW(lpName, lpGuid, pValue, nSize, dwAttributes)
// lpName : LPCWSTR -> 'str16'
// lpGuid : LPCWSTR -> 'str16'
// pValue : void* optional -> 'void *'
// nSize : DWORD -> 'uint32_t'
// dwAttributes : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
SetFirmwareEnvironmentVariableExW: { parameters: ["buffer", "buffer", "pointer", "u32", "u32"], result: "i32" },
});
// lib.symbols.SetFirmwareEnvironmentVariableExW(lpName, lpGuid, pValue, nSize, dwAttributes)
// lpName : LPCWSTR -> "buffer"
// lpGuid : LPCWSTR -> "buffer"
// pValue : void* optional -> "pointer"
// nSize : DWORD -> "u32"
// dwAttributes : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SetFirmwareEnvironmentVariableExW(
const uint16_t* lpName,
const uint16_t* lpGuid,
void* pValue,
uint32_t nSize,
uint32_t dwAttributes);
C, "KERNEL32.dll");
// $ffi->SetFirmwareEnvironmentVariableExW(lpName, lpGuid, pValue, nSize, dwAttributes);
// lpName : LPCWSTR
// lpGuid : LPCWSTR
// pValue : void* optional
// nSize : DWORD
// dwAttributes : 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 SetFirmwareEnvironmentVariableExW(
WString lpName, // LPCWSTR
WString lpGuid, // LPCWSTR
Pointer pValue, // void* optional
int nSize, // DWORD
int dwAttributes // DWORD
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("kernel32")]
lib LibKERNEL32
fun SetFirmwareEnvironmentVariableExW = SetFirmwareEnvironmentVariableExW(
lpName : UInt16*, # LPCWSTR
lpGuid : UInt16*, # LPCWSTR
pValue : Void*, # void* optional
nSize : UInt32, # DWORD
dwAttributes : 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 SetFirmwareEnvironmentVariableExWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>, Uint32, Uint32);
typedef SetFirmwareEnvironmentVariableExWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>, int, int);
final SetFirmwareEnvironmentVariableExW = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<SetFirmwareEnvironmentVariableExWNative, SetFirmwareEnvironmentVariableExWDart>('SetFirmwareEnvironmentVariableExW');
// lpName : LPCWSTR -> Pointer<Utf16>
// lpGuid : LPCWSTR -> Pointer<Utf16>
// pValue : void* optional -> Pointer<Void>
// nSize : DWORD -> Uint32
// dwAttributes : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SetFirmwareEnvironmentVariableExW(
lpName: PWideChar; // LPCWSTR
lpGuid: PWideChar; // LPCWSTR
pValue: Pointer; // void* optional
nSize: DWORD; // DWORD
dwAttributes: DWORD // DWORD
): BOOL; stdcall;
external 'KERNEL32.dll' name 'SetFirmwareEnvironmentVariableExW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SetFirmwareEnvironmentVariableExW"
c_SetFirmwareEnvironmentVariableExW :: CWString -> CWString -> Ptr () -> Word32 -> Word32 -> IO CInt
-- lpName : LPCWSTR -> CWString
-- lpGuid : LPCWSTR -> CWString
-- pValue : void* optional -> Ptr ()
-- nSize : DWORD -> Word32
-- dwAttributes : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let setfirmwareenvironmentvariableexw =
foreign "SetFirmwareEnvironmentVariableExW"
((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr void) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* lpName : LPCWSTR -> (ptr uint16_t) *)
(* lpGuid : LPCWSTR -> (ptr uint16_t) *)
(* pValue : void* optional -> (ptr void) *)
(* nSize : DWORD -> uint32_t *)
(* dwAttributes : 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 ("SetFirmwareEnvironmentVariableExW" set-firmware-environment-variable-ex-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
(dw-attributes :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SetFirmwareEnvironmentVariableExW = Win32::API::More->new('KERNEL32',
'BOOL SetFirmwareEnvironmentVariableExW(LPCWSTR lpName, LPCWSTR lpGuid, LPVOID pValue, DWORD nSize, DWORD dwAttributes)');
# my $ret = $SetFirmwareEnvironmentVariableExW->Call($lpName, $lpGuid, $pValue, $nSize, $dwAttributes);
# lpName : LPCWSTR -> LPCWSTR
# lpGuid : LPCWSTR -> LPCWSTR
# pValue : void* optional -> LPVOID
# nSize : DWORD -> DWORD
# dwAttributes : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f SetFirmwareEnvironmentVariableExA (ANSI版) — 属性付きでファームウェア環境変数の値をANSIで設定する。
類似 API
- f SetFirmwareEnvironmentVariableW — ファームウェア環境変数の値をUnicodeで設定する。