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

OLEUICHANGEICONA

構造体
サイズx64: 352 バイト / x86: 320 バイト

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

フィールド

フィールドサイズx64x86説明
cbStructDWORD4+0+0構造体のサイズ(バイト単位)。このフィールドは入力時に設定しなければなりません。
dwFlagsCHANGE_ICON_FLAGS4+4+4

入力時には初期化フラグおよび作成フラグを指定します。終了時にはユーザーが選択した内容を示します。次のフラグの組み合わせを指定できます。

意味
CIF_SHOWHELP ダイアログボックスに Help ボタンを表示します。
CIF_SELECTCURRENT 入力時は、初期化の際に Current ラジオボタンを選択します。終了時は、ユーザーが Current を選択したことを示します。
CIF_SELECTDEFAULT 入力時は、初期化の際に Default ラジオボタンを選択します。終了時は、ユーザーが Default を選択したことを示します。
CIF_SELECTFROMFILE 入力時は、初期化の際に From File ラジオボタンを選択します。終了時は、ユーザーが From File を選択したことを示します。
CIF_USEICONEXE 入力専用です。クラスから取得する代わりに、szIconExe メンバーで指定された実行可能ファイルからアイコンを抽出します。これは OLE 以外のファイルへの埋め込みやリンクに便利です。
hWndOwnerHWND8/4+8+8ダイアログボックスを所有するウィンドウ。このメンバーは NULL であってはなりません。
lpszCaptionLPSTR8/4+16+12ダイアログボックスのタイトルとして使用する文字列へのポインター。NULL の場合、ライブラリは Change Icon を使用します。
lpfnHookLPFNOLEUIHOOK8/4+24+16ダイアログボックス宛てのメッセージを処理するフック関数へのポインター。フック関数は、自身が処理しなかったメッセージをライブラリ内のダイアログボックスプロシージャに渡すために 0 を返さなければなりません。既に処理したメッセージをライブラリのダイアログボックスプロシージャが処理しないようにするには、フック関数は 0 以外の値を返さなければなりません。
lCustDataLPARAM8/4+32+20lpfnHook メンバーが指すフック関数にライブラリが渡す、アプリケーション定義のデータ。ライブラリは WM_INITDIALOG メッセージの lParam パラメーターで OLEUICHANGEICON 構造体へのポインターを渡します。このポインターを使用して lCustData メンバーを取得できます。
hInstanceHINSTANCE8/4+40+24lpTemplateName メンバーで指定されたダイアログボックステンプレートを含むインスタンス。
lpszTemplateLPSTR8/4+48+28ライブラリの Change Icon ダイアログボックステンプレートの代わりに使用する、ダイアログボックステンプレートのリソースファイル名を指定する、null で終わる文字列へのポインター。
hResourceHRSRC8/4+56+32カスタマイズされたテンプレートのハンドル。
hMetaPictHGLOBAL8/4+64+36現在および最終的なイメージ。アイコンのソースはメタファイル自体に埋め込まれています。
clsidGUID16+72+40入力専用です。Default アイコンを取得するために使用するクラス。
szIconExeCHAR260+88+56入力専用です。既定のアイコンを抽出する実行可能ファイルへのポインター。このメンバーは、dwFlags メンバーに CIF_USEICONEXE が含まれており、かつ指定された CLSID からクラスアイコンを取得する試みが失敗した場合を除き、無視されます。
cchIconExeINT4+348+316入力専用です。szIconExe の文字数。このメンバーは、dwFlags メンバーに CIF_USEICONEXE が含まれていない限り無視されます。

公式ドキュメント

OLE ユーザーインターフェイスライブラリが Change Icon ダイアログボックスを初期化するために使用する情報を格納し、ダイアログボックスが閉じられたときにライブラリが情報を返すための領域を含みます。

解説(Remarks)

メモ

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

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

各言語での定義

#include <windows.h>

// OLEUICHANGEICONA  (x64 352 / x86 320 バイト)
typedef struct OLEUICHANGEICONA {
    DWORD cbStruct;
    CHANGE_ICON_FLAGS dwFlags;
    HWND hWndOwner;
    LPSTR lpszCaption;
    LPFNOLEUIHOOK lpfnHook;
    LPARAM lCustData;
    HINSTANCE hInstance;
    LPSTR lpszTemplate;
    HRSRC hResource;
    HGLOBAL hMetaPict;
    GUID clsid;
    CHAR szIconExe[260];
    INT cchIconExe;
} OLEUICHANGEICONA;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct OLEUICHANGEICONA
{
    public uint cbStruct;
    public uint dwFlags;
    public IntPtr hWndOwner;
    public IntPtr lpszCaption;
    public IntPtr lpfnHook;
    public IntPtr lCustData;
    public IntPtr hInstance;
    public IntPtr lpszTemplate;
    public IntPtr hResource;
    public IntPtr hMetaPict;
    public Guid clsid;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst = 260)] public sbyte[] szIconExe;
    public int cchIconExe;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure OLEUICHANGEICONA
    Public cbStruct As UInteger
    Public dwFlags As UInteger
    Public hWndOwner As IntPtr
    Public lpszCaption As IntPtr
    Public lpfnHook As IntPtr
    Public lCustData As IntPtr
    Public hInstance As IntPtr
    Public lpszTemplate As IntPtr
    Public hResource As IntPtr
    Public hMetaPict As IntPtr
    Public clsid As Guid
    <MarshalAs(UnmanagedType.ByValArray, SizeConst:=260)> Public szIconExe() As SByte
    Public cchIconExe As Integer
End Structure
import ctypes
from ctypes import wintypes

class OLEUICHANGEICONA(ctypes.Structure):
    _fields_ = [
        ("cbStruct", wintypes.DWORD),
        ("dwFlags", wintypes.DWORD),
        ("hWndOwner", ctypes.c_void_p),
        ("lpszCaption", ctypes.c_void_p),
        ("lpfnHook", ctypes.c_void_p),
        ("lCustData", ctypes.c_ssize_t),
        ("hInstance", ctypes.c_void_p),
        ("lpszTemplate", ctypes.c_void_p),
        ("hResource", ctypes.c_void_p),
        ("hMetaPict", ctypes.c_void_p),
        ("clsid", GUID),
        ("szIconExe", ctypes.c_byte * 260),
        ("cchIconExe", ctypes.c_int),
    ]
#[repr(C)]
pub struct OLEUICHANGEICONA {
    pub cbStruct: u32,
    pub dwFlags: u32,
    pub hWndOwner: *mut core::ffi::c_void,
    pub lpszCaption: *mut core::ffi::c_void,
    pub lpfnHook: *mut core::ffi::c_void,
    pub lCustData: isize,
    pub hInstance: *mut core::ffi::c_void,
    pub lpszTemplate: *mut core::ffi::c_void,
    pub hResource: *mut core::ffi::c_void,
    pub hMetaPict: *mut core::ffi::c_void,
    pub clsid: GUID,
    pub szIconExe: [i8; 260],
    pub cchIconExe: i32,
}
import "golang.org/x/sys/windows"

type OLEUICHANGEICONA struct {
	cbStruct uint32
	dwFlags uint32
	hWndOwner uintptr
	lpszCaption uintptr
	lpfnHook uintptr
	lCustData uintptr
	hInstance uintptr
	lpszTemplate uintptr
	hResource uintptr
	hMetaPict uintptr
	clsid windows.GUID
	szIconExe [260]int8
	cchIconExe int32
}
type
  OLEUICHANGEICONA = record
    cbStruct: DWORD;
    dwFlags: DWORD;
    hWndOwner: Pointer;
    lpszCaption: Pointer;
    lpfnHook: Pointer;
    lCustData: NativeInt;
    hInstance: Pointer;
    lpszTemplate: Pointer;
    hResource: Pointer;
    hMetaPict: Pointer;
    clsid: TGUID;
    szIconExe: array[0..259] of Shortint;
    cchIconExe: Integer;
  end;
const OLEUICHANGEICONA = extern struct {
    cbStruct: u32,
    dwFlags: u32,
    hWndOwner: ?*anyopaque,
    lpszCaption: ?*anyopaque,
    lpfnHook: ?*anyopaque,
    lCustData: isize,
    hInstance: ?*anyopaque,
    lpszTemplate: ?*anyopaque,
    hResource: ?*anyopaque,
    hMetaPict: ?*anyopaque,
    clsid: GUID,
    szIconExe: [260]i8,
    cchIconExe: i32,
};
type
  OLEUICHANGEICONA {.bycopy.} = object
    cbStruct: uint32
    dwFlags: uint32
    hWndOwner: pointer
    lpszCaption: pointer
    lpfnHook: pointer
    lCustData: int
    hInstance: pointer
    lpszTemplate: pointer
    hResource: pointer
    hMetaPict: pointer
    clsid: GUID
    szIconExe: array[260, int8]
    cchIconExe: int32
struct OLEUICHANGEICONA
{
    uint cbStruct;
    uint dwFlags;
    void* hWndOwner;
    void* lpszCaption;
    void* lpfnHook;
    ptrdiff_t lCustData;
    void* hInstance;
    void* lpszTemplate;
    void* hResource;
    void* hMetaPict;
    GUID clsid;
    byte[260] szIconExe;
    int cchIconExe;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; OLEUICHANGEICONA サイズ: 320 バイト(x86)
dim st, 80    ; 4byte整数×80(構造体サイズ 320 / 4 切り上げ)
; cbStruct : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwFlags : CHANGE_ICON_FLAGS (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; hWndOwner : HWND (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; lpszCaption : LPSTR (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; lpfnHook : LPFNOLEUIHOOK (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; lCustData : LPARAM (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; hInstance : HINSTANCE (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; lpszTemplate : LPSTR (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; hResource : HRSRC (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; hMetaPict : HGLOBAL (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; clsid : GUID (+40, 16byte)  varptr(st)+40 を基点に操作(16byte:入れ子/配列)
; szIconExe : CHAR (+56, 260byte)  varptr(st)+56 を基点に操作(260byte:入れ子/配列)
; cchIconExe : INT (+316, 4byte)  st.79 = 値  /  値 = st.79   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; OLEUICHANGEICONA サイズ: 352 バイト(x64)
dim st, 88    ; 4byte整数×88(構造体サイズ 352 / 4 切り上げ)
; cbStruct : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwFlags : CHANGE_ICON_FLAGS (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; hWndOwner : HWND (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; lpszCaption : LPSTR (+16, 8byte)  qpoke st,16,値 / qpeek(st,16)  ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; lpfnHook : LPFNOLEUIHOOK (+24, 8byte)  qpoke st,24,値 / qpeek(st,24)  ※IronHSPのみ。3.7/3.8は lpoke st,24,下位 : lpoke st,28,上位
; lCustData : LPARAM (+32, 8byte)  qpoke st,32,値 / qpeek(st,32)  ※IronHSPのみ。3.7/3.8は lpoke st,32,下位 : lpoke st,36,上位
; hInstance : HINSTANCE (+40, 8byte)  qpoke st,40,値 / qpeek(st,40)  ※IronHSPのみ。3.7/3.8は lpoke st,40,下位 : lpoke st,44,上位
; lpszTemplate : LPSTR (+48, 8byte)  qpoke st,48,値 / qpeek(st,48)  ※IronHSPのみ。3.7/3.8は lpoke st,48,下位 : lpoke st,52,上位
; hResource : HRSRC (+56, 8byte)  qpoke st,56,値 / qpeek(st,56)  ※IronHSPのみ。3.7/3.8は lpoke st,56,下位 : lpoke st,60,上位
; hMetaPict : HGLOBAL (+64, 8byte)  qpoke st,64,値 / qpeek(st,64)  ※IronHSPのみ。3.7/3.8は lpoke st,64,下位 : lpoke st,68,上位
; clsid : GUID (+72, 16byte)  varptr(st)+72 を基点に操作(16byte:入れ子/配列)
; szIconExe : CHAR (+88, 260byte)  varptr(st)+88 を基点に操作(260byte:入れ子/配列)
; cchIconExe : INT (+348, 4byte)  st.87 = 値  /  値 = st.87   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global GUID, pack=1
    #field int Data1
    #field short Data2
    #field short Data3
    #field byte Data4 8
#endstruct

#defstruct global OLEUICHANGEICONA
    #field int cbStruct
    #field int dwFlags
    #field intptr hWndOwner
    #field intptr lpszCaption
    #field intptr lpfnHook
    #field intptr lCustData
    #field intptr hInstance
    #field intptr lpszTemplate
    #field intptr hResource
    #field intptr hMetaPict
    #field GUID clsid
    #field byte szIconExe 260
    #field int cchIconExe
#endstruct

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