Win32 API 日本語リファレンス
ホームUI.WindowsAndMessaging › ICONINFO

ICONINFO

構造体
サイズx64: 32 バイト / x86: 20 バイト

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

フィールド

フィールドサイズx64x86説明
fIconBOOL4+0+0この構造体がアイコンとカーソルのどちらを定義するかを指定します。値が TRUE の場合はアイコンを、FALSE の場合はカーソルを指定します。
xHotspotDWORD4+4+4カーソルのホットスポットの x 座標です。この構造体がアイコンを定義する場合、ホットスポットは常にアイコンの中心になるため、このメンバーは無視されます。
yHotspotDWORD4+8+8カーソルのホットスポットの y 座標です。この構造体がアイコンを定義する場合、ホットスポットは常にアイコンの中心になるため、このメンバーは無視されます。
hbmMaskHBITMAP8/4+16+12アイコンのモノクロマスク ビットマップ へのハンドルです。
hbmColorHBITMAP8/4+24+16アイコンのカラー ビットマップ へのハンドルです。

公式ドキュメント

アイコンまたはカーソルに関する情報を格納します。

解説(Remarks)

モノクロアイコンの場合、hbmMask の高さはアイコンの 2 倍になり (上半分に AND マスク、下半分に XOR マスクが配置されます)、hbmColorNULL になります。また、この場合、高さは 2 の倍数でなければなりません。

カラーアイコンの場合、hbmMaskhbmColor のビットマップは同じサイズであり、いずれもアイコンのサイズと同じです。

hbmMaskhbmColor の内容は、GetObject 関数を使用して BITMAP 構造体として取得できます。ビットマップのビットは、この構造体に含まれるビットマップに対して GetDIBits を呼び出すことで取得できます。

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

各言語での定義

#include <windows.h>

// ICONINFO  (x64 32 / x86 20 バイト)
typedef struct ICONINFO {
    BOOL fIcon;
    DWORD xHotspot;
    DWORD yHotspot;
    HBITMAP hbmMask;
    HBITMAP hbmColor;
} ICONINFO;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct ICONINFO
{
    [MarshalAs(UnmanagedType.Bool)] public bool fIcon;
    public uint xHotspot;
    public uint yHotspot;
    public IntPtr hbmMask;
    public IntPtr hbmColor;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure ICONINFO
    <MarshalAs(UnmanagedType.Bool)> Public fIcon As Boolean
    Public xHotspot As UInteger
    Public yHotspot As UInteger
    Public hbmMask As IntPtr
    Public hbmColor As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class ICONINFO(ctypes.Structure):
    _fields_ = [
        ("fIcon", wintypes.BOOL),
        ("xHotspot", wintypes.DWORD),
        ("yHotspot", wintypes.DWORD),
        ("hbmMask", ctypes.c_void_p),
        ("hbmColor", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct ICONINFO {
    pub fIcon: i32,
    pub xHotspot: u32,
    pub yHotspot: u32,
    pub hbmMask: *mut core::ffi::c_void,
    pub hbmColor: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type ICONINFO struct {
	fIcon int32
	xHotspot uint32
	yHotspot uint32
	hbmMask uintptr
	hbmColor uintptr
}
type
  ICONINFO = record
    fIcon: BOOL;
    xHotspot: DWORD;
    yHotspot: DWORD;
    hbmMask: Pointer;
    hbmColor: Pointer;
  end;
const ICONINFO = extern struct {
    fIcon: i32,
    xHotspot: u32,
    yHotspot: u32,
    hbmMask: ?*anyopaque,
    hbmColor: ?*anyopaque,
};
type
  ICONINFO {.bycopy.} = object
    fIcon: int32
    xHotspot: uint32
    yHotspot: uint32
    hbmMask: pointer
    hbmColor: pointer
struct ICONINFO
{
    int fIcon;
    uint xHotspot;
    uint yHotspot;
    void* hbmMask;
    void* hbmColor;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; ICONINFO サイズ: 20 バイト(x86)
dim st, 5    ; 4byte整数×5(構造体サイズ 20 / 4 切り上げ)
; fIcon : BOOL (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; xHotspot : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; yHotspot : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; hbmMask : HBITMAP (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; hbmColor : HBITMAP (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; ICONINFO サイズ: 32 バイト(x64)
dim st, 8    ; 4byte整数×8(構造体サイズ 32 / 4 切り上げ)
; fIcon : BOOL (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; xHotspot : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; yHotspot : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; hbmMask : HBITMAP (+16, 8byte)  qpoke st,16,値 / qpeek(st,16)  ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; hbmColor : HBITMAP (+24, 8byte)  qpoke st,24,値 / qpeek(st,24)  ※IronHSPのみ。3.7/3.8は lpoke st,24,下位 : lpoke st,28,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global ICONINFO
    #field bool fIcon
    #field int xHotspot
    #field int yHotspot
    #field intptr hbmMask
    #field intptr hbmColor
#endstruct

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