ホーム › System.Ioctl › STORAGE_HOTPLUG_INFO

STORAGE_HOTPLUG_INFO

構造体

サイズx64: 8 バイト / x86: 8 バイト

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

フィールド

フィールド	型	サイズ	x64	x86	説明
Size	DWORD	4	+0	+0	この構造体のサイズ (バイト単位)。呼び出し元は、このメンバーに `sizeof(STORAGE_HOTPLUG_INFO)` を設定しなければなりません。
MediaRemovable	BOOLEAN	1	+4	+4	このメンバーに 0 以外の値が設定されている場合、デバイスのメディアはリムーバブルです。それ以外の場合、デバイスのメディアはリムーバブルではありません。
MediaHotplug	BOOLEAN	1	+5	+5	このメンバーに 0 以外の値が設定されている場合、メディアはロックできません。それ以外の場合、デバイスのメディアはロック可能です。
DeviceHotplug	BOOLEAN	1	+6	+6	このメンバーに 0 以外の値が設定されている場合、そのデバイスはホットプラグデバイスです。それ以外の場合、そのデバイスはホットプラグデバイスではありません。
WriteCacheEnableOverride	BOOLEAN	1	+7	+7	予約済みです。値には NULL を設定してください。

公式ドキュメント

デバイスのホットプラグ情報を提供します。

解説(Remarks)

Size メンバーの値は、この構造体のバージョンも示します。これは、将来この構造体にメンバーが追加されるためです。Size メンバーの値が sizeof(STORAGE_HOTPLUG_INFO) である場合、現在のバージョンの構造体は、コンパイル時に使用したバージョンと同じです。値が sizeof(STORAGE_HOTPLUG_INFO) でない場合、現在のバージョンには追加のメンバーが含まれています。

ホットプラグデバイスとは、デバイスマネージャーに表示される RemovalPolicy の値が ExpectSurpriseRemoval であるデバイスを指します。特定のデバイスがホットプラグデバイスかどうかを照会するには、 IOCTL_STORAGE_GET_HOTPLUG_INFO 操作を使用します。デバイスのホットプラグプロパティを設定するには、 IOCTL_STORAGE_SET_HOTPLUG_INFO 操作を使用します。

IOCTL_STORAGE_SET_HOTPLUG_INFO 操作では、この構造体の DeviceHotplug メンバーの値のみが設定されます。このメンバーの値が設定されている場合、指定したデバイスの削除ポリシーは ExpectSurpriseRemoval に設定され、すべてのレベルのキャッシュが無効になります。このメンバーの値が設定されていない場合、指定したデバイスの削除ポリシーは ExpectOrderlyRemoval に設定され、キャッシュを選択的に有効にできます。

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

各言語での定義

#include <windows.h>

// STORAGE_HOTPLUG_INFO  (x64 8 / x86 8 バイト)
typedef struct STORAGE_HOTPLUG_INFO {
    DWORD Size;
    BOOLEAN MediaRemovable;
    BOOLEAN MediaHotplug;
    BOOLEAN DeviceHotplug;
    BOOLEAN WriteCacheEnableOverride;
} STORAGE_HOTPLUG_INFO;

using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct STORAGE_HOTPLUG_INFO
{
    public uint Size;
    [MarshalAs(UnmanagedType.U1)] public bool MediaRemovable;
    [MarshalAs(UnmanagedType.U1)] public bool MediaHotplug;
    [MarshalAs(UnmanagedType.U1)] public bool DeviceHotplug;
    [MarshalAs(UnmanagedType.U1)] public bool WriteCacheEnableOverride;
}

Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure STORAGE_HOTPLUG_INFO
    Public Size As UInteger
    <MarshalAs(UnmanagedType.U1)> Public MediaRemovable As Boolean
    <MarshalAs(UnmanagedType.U1)> Public MediaHotplug As Boolean
    <MarshalAs(UnmanagedType.U1)> Public DeviceHotplug As Boolean
    <MarshalAs(UnmanagedType.U1)> Public WriteCacheEnableOverride As Boolean
End Structure

import ctypes
from ctypes import wintypes

class STORAGE_HOTPLUG_INFO(ctypes.Structure):
    _fields_ = [
        ("Size", wintypes.DWORD),
        ("MediaRemovable", ctypes.c_byte),
        ("MediaHotplug", ctypes.c_byte),
        ("DeviceHotplug", ctypes.c_byte),
        ("WriteCacheEnableOverride", ctypes.c_byte),
    ]

#[repr(C)]
pub struct STORAGE_HOTPLUG_INFO {
    pub Size: u32,
    pub MediaRemovable: u8,
    pub MediaHotplug: u8,
    pub DeviceHotplug: u8,
    pub WriteCacheEnableOverride: u8,
}

import "golang.org/x/sys/windows"

type STORAGE_HOTPLUG_INFO struct {
	Size uint32
	MediaRemovable byte
	MediaHotplug byte
	DeviceHotplug byte
	WriteCacheEnableOverride byte
}

type
  STORAGE_HOTPLUG_INFO = record
    Size: DWORD;
    MediaRemovable: ByteBool;
    MediaHotplug: ByteBool;
    DeviceHotplug: ByteBool;
    WriteCacheEnableOverride: ByteBool;
  end;

const STORAGE_HOTPLUG_INFO = extern struct {
    Size: u32,
    MediaRemovable: u8,
    MediaHotplug: u8,
    DeviceHotplug: u8,
    WriteCacheEnableOverride: u8,
};

type
  STORAGE_HOTPLUG_INFO {.bycopy.} = object
    Size: uint32
    MediaRemovable: uint8
    MediaHotplug: uint8
    DeviceHotplug: uint8
    WriteCacheEnableOverride: uint8

struct STORAGE_HOTPLUG_INFO
{
    uint Size;
    ubyte MediaRemovable;
    ubyte MediaHotplug;
    ubyte DeviceHotplug;
    ubyte WriteCacheEnableOverride;
}

HSP用定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; STORAGE_HOTPLUG_INFO サイズ: 8 バイト(x64)
dim st, 2    ; 4byte整数×2(構造体サイズ 8 / 4 切り上げ)
; Size : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; MediaRemovable : BOOLEAN (+4, 1byte)  poke st,4,値  /  値 = peek(st,4)
; MediaHotplug : BOOLEAN (+5, 1byte)  poke st,5,値  /  値 = peek(st,5)
; DeviceHotplug : BOOLEAN (+6, 1byte)  poke st,6,値  /  値 = peek(st,6)
; WriteCacheEnableOverride : BOOLEAN (+7, 1byte)  poke st,7,値  /  値 = peek(st,7)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。

; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global STORAGE_HOTPLUG_INFO
    #field int Size
    #field bool1 MediaRemovable
    #field bool1 MediaHotplug
    #field bool1 DeviceHotplug
    #field bool1 WriteCacheEnableOverride
#endstruct

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