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

SetFirmwareEnvironmentVariableExW

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

シグネチャ

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

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

パラメーター

名前型方向説明
lpNameLPCWSTRinファームウェア環境変数の名前。このポインターを NULL にすることはできません。
lpGuidLPCWSTRinファームウェア環境変数の名前空間を表す GUID。この GUID は "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}" の形式の文字列である必要があります。システムが GUID ベースの名前空間をサポートしていない場合、このパラメーターは無視されます。このポインターを NULL にすることはできません。
pValuevoid*inoptionalファームウェア環境変数の新しい値へのポインター。
nSizeDWORDinpValue バッファーのサイズ (バイト単位)。VARIABLE_ATTRIBUTE_APPEND_WRITE、 VARIABLE_ATTRIBUTE_AUTHENTICATED_WRITE_ACCESS、または VARIABLE_ATTRIBUTE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS の変数属性が dwAttributes によって設定されていない限り、 この値を 0 に設定すると、この変数は削除されます。
dwAttributesDWORDin

変数に関連付ける UEFI 変数属性を設定するためのビットマスク。UEFI Spec 2.3.1, Section 7.2 も参照してください。

値 意味
VARIABLE_ATTRIBUTE_NON_VOLATILE
0x00000001
ファームウェア環境変数が不揮発性メモリ (NVRAM など) に格納されます。
VARIABLE_ATTRIBUTE_BOOTSERVICE_ACCESS
0x00000002
ファームウェア環境変数にブートサービス中にアクセスできます。
VARIABLE_ATTRIBUTE_RUNTIME_ACCESS
0x00000004
ファームウェア環境変数に実行時にアクセスできます。
注意 この属性が設定された変数には、 VARIABLE_ATTRIBUTE_BOOTSERVICE_ACCESS も設定する必要があります。
VARIABLE_ATTRIBUTE_HARDWARE_ERROR_RECORD
0x00000008
実行時に発生したハードウェア関連のエラーを示します。
VARIABLE_ATTRIBUTE_AUTHENTICATED_WRITE_ACCESS
0x00000010
このファームウェア環境変数に書き込む前に満たす必要がある認証要件を示します。詳細については、UEFI spec 2.3.1 を参照してください。
VARIABLE_ATTRIBUTE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
0x00000020
このファームウェア環境変数に書き込む前に満たす必要がある認証要件およびタイムスタンプ要件を示します。この属性が設定されている場合、pValue が表すバッファーは、完全な (シリアル化された) EFI_VARIABLE_AUTHENTICATION_2 記述子のインスタンスで始まります。詳細については、UEFI spec 2.3.1 を参照してください。
VARIABLE_ATTRIBUTE_APPEND_WRITE
0x00000040
既存の環境変数に pValue の値を追加します。ファームウェアがこの操作をサポートしていない場合、SetFirmwareEnvironmentVariableEx は ERROR_INVALID_FUNCTION を返します。

戻り値の型: BOOL

公式ドキュメント

指定されたファームウェア環境変数の値と、この変数がどのように格納および保守されるかを示す属性を設定します。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。返される可能性のあるエラーコードには ERROR_INVALID_FUNCTION が含まれます。

解説(Remarks)

Windows 10 バージョン 1803 以降では、ユニバーサル Windows アプリで UEFI ファームウェア変数の読み取りと書き込みができます。詳細については、Access UEFI firmware variables from a Universal Windows App を参照してください。

Windows 10 バージョン 1803 以降では、User-Mode Driver Framework (UMDF) ドライバーからも UEFI ファームウェア変数の読み取りがサポートされます。UMDF ドライバーからの UEFI ファームウェア変数の書き込みはサポートされていません。

ファームウェア環境変数を書き込むには、アプリを実行しているユーザーアカウントに SE_SYSTEM_ENVIRONMENT_NAME 特権が必要です。ユニバーサル Windows アプリは管理者アカウントから実行し、Access UEFI firmware variables from a Universal Windows App に示されている要件に従う必要があります。

変数の属性を変更する正しい方法は、その変数を削除し、異なる属性で作成し直すことです。

ファームウェア環境変数の正確なセットは、ブートファームウェアによって決まります。これらの環境変数の格納場所もファームウェアによって指定されます。たとえば、UEFI ベースのシステムでは、システムのブート設定を指定するファームウェア環境変数が NVRAM に格納されます。使用される個々の変数については、UEFI 仕様を参照してください。UEFI と Windows の詳細については、UEFI and Windows を参照してください。

ファームウェア変数は、レガシ BIOS ベースのシステムではサポートされません。SetFirmwareEnvironmentVariableEx 関数は、レガシ BIOS ベースのシステム、またはレガシ BIOS と UEFI の両方をサポートするシステムで Windows がレガシ BIOS を使用してインストールされている場合、常に失敗します。これらの条件を識別するには、lpName パラメーターに空の文字列 ("") などのダミーのファームウェア環境変数名を指定し、lpGuid パラメーターに "{00000000-0000-0000-0000-000000000000}" などのダミーの GUID を指定して、この関数を呼び出します。レガシ BIOS ベースのシステム、またはレガシ BIOS と UEFI の両方をサポートするシステムで Windows がレガシ BIOS を使用してインストールされている場合、この関数は ERROR_INVALID_FUNCTION で失敗します。UEFI ベースのシステムでは、ダミーの GUID 名前空間が存在しないことを示す ERROR_NOACCESS などの、ファームウェア固有のエラーで失敗します。

メモ

winbase.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SetFirmwareEnvironmentVariableEx を定義します。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// 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   // BOOL
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';
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 変換を行う。

関連項目

文字セット違い
類似 API
公式の関連項目