ホーム › System.SystemInformation › GetSystemFirmwareTable

GetSystemFirmwareTable

関数

指定したシステムファームウェアテーブルの内容を取得する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

DWORD GetSystemFirmwareTable(
    FIRMWARE_TABLE_PROVIDER FirmwareTableProviderSignature,
    DWORD FirmwareTableID,
    BYTE* pFirmwareTableBuffer,   // optional
    DWORD BufferSize
);

パラメーター

名前型方向説明

FirmwareTableProviderSignature

FIRMWARE_TABLE_PROVIDER

クエリの送信先となるファームウェアテーブルプロバイダーの識別子です。このパラメーターには、次のいずれかの値を指定できます。

値	意味
'ACPI'	ACPI ファームウェアテーブルプロバイダー。
'FIRM'	raw ファームウェアテーブルプロバイダー。
'RSMB'	raw SMBIOS ファームウェアテーブルプロバイダー。

FirmwareTableID

DWORD

ファームウェアテーブルの識別子です。この識別子はリトルエンディアンであるため、文字列内の文字を逆順にする必要があります。

たとえば、ACPI 仕様の DESCRIPTION_HEADER 構造体の Signature フィールドに記載されているとおり、FACP は ACPI プロバイダーです(Advanced Configuration and Power Interface (ACPI) Specification を参照)。したがって、FACP テーブルを指定するには、次の例のように 'PCAF' を使用します。

retVal = GetSystemFirmwareTable('ACPI', 'PCAF', pBuffer, BUFSIZE);

詳細については、EnumSystemFirmwareTables 関数の解説セクションを参照してください。

pFirmwareTableBuffer

BYTE*

outoptional

要求されたファームウェアテーブルを受け取るバッファーへのポインターです。このパラメーターが NULL の場合、戻り値は必要なバッファーサイズになります。

このバッファーの内容の詳細については、解説セクションを参照してください。

BufferSize DWORD in pFirmwareTableBuffer バッファーのサイズ(バイト単位)です。

戻り値の型: DWORD

公式ドキュメント

ファームウェアテーブルプロバイダーから、指定されたファームウェアテーブルを取得します。

戻り値

関数が成功した場合、戻り値はバッファーに書き込まれたバイト数です。この値は常に BufferSize 以下になります。

バッファーのサイズが不足しているために関数が失敗した場合、戻り値は必要なバッファーサイズ(バイト単位)です。この値は常に BufferSize より大きくなります。

その他の理由で関数が失敗した場合、戻り値はゼロです。拡張エラー情報を取得するには、GetLastError を呼び出してください。

解説(Remarks)

Windows 10 バージョン 1803 以降では、ユニバーサル Windows アプリは、アプリマニフェストで smbios 制限付き機能を宣言することで、System Management BIOS (SMBIOS) 情報にアクセスできます。詳細については、Access SMBIOS information from a Universal Windows App を参照してください。ユニバーサル Windows アプリからアクセスできるのは、raw SMBIOS (RSMB) ファームウェアテーブルのみです。

Windows Server 2003 with Service Pack 1 (SP1) 以降では、アプリケーションは \Device\PhysicalMemory オブジェクトにアクセスできません。このオブジェクトへのアクセスは、カーネルモードドライバーに限定されています。この変更は、System Management BIOS (SMBIOS) や物理メモリの最下位 1MB に格納されたその他の BIOS データを読み取るアプリケーションに影響します。アプリケーションが低位物理メモリからデータを読み取るには、次の代替手段があります。

WMI を使用して SMBIOS のプロパティを取得します。多くの個別プロパティは Win32 クラスに含まれています。また、MSSMBios_RawSMBiosTables クラスを使用して、raw SMBIOS データを単一のバッファーとして取得することもできます。
GetSystemFirmwareTable 関数を使用して、raw SMBIOS ファームウェアテーブルを読み取ります。

アプリケーションが低位物理メモリに書き込む方法はありません。

raw SMBIOS テーブルプロバイダー('RSMB')は、raw SMBIOS ファームウェアテーブルの内容を取得します。pFirmwareTableBuffer バッファーは次のデータを受け取ります。

#include <windows.h>

struct RawSMBIOSData
{
    BYTE    Used20CallingMethod;
    BYTE    SMBIOSMajorVersion;
    BYTE    SMBIOSMinorVersion;
    BYTE    DmiRevision;
    DWORD   Length;
    BYTE    SMBIOSTableData[];
};

raw ファームウェアテーブルプロバイダー('FIRM')は、指定された物理アドレス範囲の内容を取得します。この関数はアドレス範囲のサイズを返します。

ACPI テーブルプロバイダー('ACPI')は、指定された ACPI テーブルの内容を取得します。OEM は ACPI 仕様に記載されていない ACPI ファームウェアテーブルを含めることができるため、まず EnumSystemFirmwareTables を呼び出して、システムに現在存在するすべての ACPI テーブルを列挙してください。

ACPI の場合、システムに同じ名前のテーブルが複数含まれているときは、それらはすべて EnumSystemFirmwareTables によって列挙されます。ただし、GetSystemFirmwareTable はこの名前を持つリスト内の最初のテーブルのみを取得します。

例

次の例は、SMBIOS テーブルの取得方法を示しています。

DWORD error = ERROR_SUCCESS;
DWORD smBiosDataSize = 0;
RawSMBIOSData* smBiosData = NULL; // Defined in this link
DWORD bytesWritten = 0;

// Query size of SMBIOS data.
smBiosDataSize = GetSystemFirmwareTable('RSMB', 0, NULL, 0);

// Allocate memory for SMBIOS data
smBiosData = (RawSMBIOSData*) HeapAlloc(GetProcessHeap(), 0, smBiosDataSize);
if (!smBiosData) {
    error = ERROR_OUTOFMEMORY;
    goto exit;
}

// Retrieve the SMBIOS table
bytesWritten = GetSystemFirmwareTable('RSMB', 0, smBiosData, smBiosDataSize);

if (bytesWritten != smBiosDataSize) {
    error = ERROR_INVALID_DATA;
    goto exit;
}

// Process the SMBIOS data and free the memory under an exit label

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

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

DWORD GetSystemFirmwareTable(
    FIRMWARE_TABLE_PROVIDER FirmwareTableProviderSignature,
    DWORD FirmwareTableID,
    BYTE* pFirmwareTableBuffer,   // optional
    DWORD BufferSize
);

[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern uint GetSystemFirmwareTable(
    uint FirmwareTableProviderSignature,   // FIRMWARE_TABLE_PROVIDER
    uint FirmwareTableID,   // DWORD
    IntPtr pFirmwareTableBuffer,   // BYTE* optional, out
    uint BufferSize   // DWORD
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetSystemFirmwareTable(
    FirmwareTableProviderSignature As UInteger,   ' FIRMWARE_TABLE_PROVIDER
    FirmwareTableID As UInteger,   ' DWORD
    pFirmwareTableBuffer As IntPtr,   ' BYTE* optional, out
    BufferSize As UInteger   ' DWORD
) As UInteger
End Function

' FirmwareTableProviderSignature : FIRMWARE_TABLE_PROVIDER
' FirmwareTableID : DWORD
' pFirmwareTableBuffer : BYTE* optional, out
' BufferSize : DWORD
Declare PtrSafe Function GetSystemFirmwareTable Lib "kernel32" ( _
    ByVal FirmwareTableProviderSignature As Long, _
    ByVal FirmwareTableID As Long, _
    ByVal pFirmwareTableBuffer As LongPtr, _
    ByVal BufferSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetSystemFirmwareTable = ctypes.windll.kernel32.GetSystemFirmwareTable
GetSystemFirmwareTable.restype = wintypes.DWORD
GetSystemFirmwareTable.argtypes = [
    wintypes.DWORD,  # FirmwareTableProviderSignature : FIRMWARE_TABLE_PROVIDER
    wintypes.DWORD,  # FirmwareTableID : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pFirmwareTableBuffer : BYTE* optional, out
    wintypes.DWORD,  # BufferSize : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetSystemFirmwareTable = Fiddle::Function.new(
  lib['GetSystemFirmwareTable'],
  [
    -Fiddle::TYPE_INT,  # FirmwareTableProviderSignature : FIRMWARE_TABLE_PROVIDER
    -Fiddle::TYPE_INT,  # FirmwareTableID : DWORD
    Fiddle::TYPE_VOIDP,  # pFirmwareTableBuffer : BYTE* optional, out
    -Fiddle::TYPE_INT,  # BufferSize : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetSystemFirmwareTable(
        FirmwareTableProviderSignature: u32,  // FIRMWARE_TABLE_PROVIDER
        FirmwareTableID: u32,  // DWORD
        pFirmwareTableBuffer: *mut u8,  // BYTE* optional, out
        BufferSize: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern uint GetSystemFirmwareTable(uint FirmwareTableProviderSignature, uint FirmwareTableID, IntPtr pFirmwareTableBuffer, uint BufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetSystemFirmwareTable' -Namespace Win32 -PassThru
# $api::GetSystemFirmwareTable(FirmwareTableProviderSignature, FirmwareTableID, pFirmwareTableBuffer, BufferSize)

#uselib "KERNEL32.dll"
#func global GetSystemFirmwareTable "GetSystemFirmwareTable" sptr, sptr, sptr, sptr
; GetSystemFirmwareTable FirmwareTableProviderSignature, FirmwareTableID, varptr(pFirmwareTableBuffer), BufferSize   ; 戻り値は stat
; FirmwareTableProviderSignature : FIRMWARE_TABLE_PROVIDER -> "sptr"
; FirmwareTableID : DWORD -> "sptr"
; pFirmwareTableBuffer : BYTE* optional, out -> "sptr"
; BufferSize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetSystemFirmwareTable "GetSystemFirmwareTable" int, int, var, int
; res = GetSystemFirmwareTable(FirmwareTableProviderSignature, FirmwareTableID, pFirmwareTableBuffer, BufferSize)
; FirmwareTableProviderSignature : FIRMWARE_TABLE_PROVIDER -> "int"
; FirmwareTableID : DWORD -> "int"
; pFirmwareTableBuffer : BYTE* optional, out -> "var"
; BufferSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetSystemFirmwareTable "GetSystemFirmwareTable" int, int, sptr, int
; res = GetSystemFirmwareTable(FirmwareTableProviderSignature, FirmwareTableID, varptr(pFirmwareTableBuffer), BufferSize)
; FirmwareTableProviderSignature : FIRMWARE_TABLE_PROVIDER -> "int"
; FirmwareTableID : DWORD -> "int"
; pFirmwareTableBuffer : BYTE* optional, out -> "sptr"
; BufferSize : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。