Win32 API 日本語リファレンス
ホーム › Devices.DeviceAndDriverInstallation › SP_CLASSINSTALL_HEADER

SP_CLASSINSTALL_HEADER

構造体
📘 Microsoft Learn (日本語) · English
サイズx64: 8 バイト / x86: 8 バイトパッキング1

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールド型サイズx64x86説明
cbSizeDWORD4+0+0SP_CLASSINSTALL_HEADER 構造体のサイズ (バイト単位)。
InstallFunctionDI_FUNCTION4+4+4

クラスインストールパラメーター構造体に対するデバイスインストール要求 (DIF コード)。

DIF コードは DIF_XXX という形式を持ち、Setupapi.h で定義されています。DIF コードの詳細な説明については、Device Installation Function Codes を参照してください。

公式ドキュメント

SP_CLASSINSTALL_HEADER は、あらゆるクラスインストールパラメーター構造体の最初のメンバーです。インストールパラメーター構造体の残りの部分の形式を定義するデバイスインストール要求コードを格納します。

解説(Remarks)

コンポーネントがクラスインストールパラメーター構造体を割り当てる際には、通常、構造体のヘッダーフィールドを初期化します。その場合、InstallFunction メンバーにインストール要求の DIF コードを設定し、cbSize に SP_CLASSINSTALL_HEADER 構造体のサイズを設定します。次に例を示します。

SP_REMOVEDEVICE_PARAMS RemoveDeviceParams;
RemoveDeviceParams.ClassInstallHeader.cbSize = sizeof(SP_CLASSINSTALL_HEADER);
RemoveDeviceParams.ClassInstallHeader.InstallFunction = DIF_REMOVE;

コンポーネントは、クラスインストールパラメーター構造体を SetupDiSetClassInstallParams に渡す前に、InstallFunction メンバーを設定しなければなりません。

ただし、クラスインストールパラメーターを SetupDiGetClassInstallParams に渡す場合は、このフィールドを設定する必要はありません。この関数は、呼び出し元に返す構造体の InstallFunction メンバーを設定します。InstallFunction には、現在アクティブなデバイスインストール要求に対応する DIF_XXX コードが設定されます。

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

各言語での定義

#include <windows.h>

// SP_CLASSINSTALL_HEADER  (x64 8 / x86 8 バイト)
#pragma pack(push, 1)
typedef struct SP_CLASSINSTALL_HEADER {
    DWORD cbSize;
    DI_FUNCTION InstallFunction;
} SP_CLASSINSTALL_HEADER;
#pragma pack(pop)
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, Pack = 1, CharSet = CharSet.Unicode)]
public struct SP_CLASSINSTALL_HEADER
{
    public uint cbSize;
    public uint InstallFunction;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, Pack:=1, CharSet:=CharSet.Unicode)>
Public Structure SP_CLASSINSTALL_HEADER
    Public cbSize As UInteger
    Public InstallFunction As UInteger
End Structure
import ctypes
from ctypes import wintypes

class SP_CLASSINSTALL_HEADER(ctypes.Structure):
    _pack_ = 1
    _fields_ = [
        ("cbSize", wintypes.DWORD),
        ("InstallFunction", wintypes.DWORD),
    ]
#[repr(C, packed(1))]
pub struct SP_CLASSINSTALL_HEADER {
    pub cbSize: u32,
    pub InstallFunction: u32,
}
import "golang.org/x/sys/windows"

type SP_CLASSINSTALL_HEADER struct {
	cbSize uint32
	InstallFunction uint32
}
type
  SP_CLASSINSTALL_HEADER = packed record
    cbSize: DWORD;
    InstallFunction: DWORD;
  end;
const SP_CLASSINSTALL_HEADER = extern struct {
    cbSize: u32,
    InstallFunction: u32,
};
type
  SP_CLASSINSTALL_HEADER {.packed.} = object
    cbSize: uint32
    InstallFunction: uint32
align(1)
struct SP_CLASSINSTALL_HEADER
{
    uint cbSize;
    uint InstallFunction;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; SP_CLASSINSTALL_HEADER サイズ: 8 バイト(x64)
dim st, 2    ; 4byte整数×2(構造体サイズ 8 / 4 切り上げ)
; cbSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; InstallFunction : DI_FUNCTION (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global SP_CLASSINSTALL_HEADER, pack=1
    #field int cbSize
    #field int InstallFunction
#endstruct

stdim st, SP_CLASSINSTALL_HEADER        ; NSTRUCT 変数を確保
st->cbSize = 100
mes "cbSize=" + st->cbSize