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

CPLINFO

構造体
サイズx64: 20 バイト / x86: 16 バイトパッキング1

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

フィールド

フィールドサイズx64x86説明
idIconINT4+0+0ダイアログ ボックスを表すアイコンのリソース識別子です。
idNameINT4+4+4ダイアログ ボックスの短い名前を含む文字列のリソース識別子です。この名前は、アイコンの下に表示されることを想定しています。
idInfoINT4+8+8アプリケーションのアイコンが選択されたときに表示されることを想定した、ダイアログ ボックスの説明を含む文字列のリソース識別子です。
lDataINT_PTR8/4+12+12アプリケーションが定義するデータへのポインターです。コントロール パネルは、CPL_DBLCLK メッセージおよび CPL_STOP メッセージを送信するときに、この値をアプリケーションに渡し返します。

公式ドキュメント

コントロール パネル アプリケーションがサポートするダイアログ ボックスのリソース情報と、アプリケーション定義の値を格納します。コントロール パネル アプリケーションの CPlApplet 関数は、CPL_INQUIRE メッセージに応答して、この情報をコントロール パネルに返します。

解説(Remarks)

ダイアログ ボックスのアイコンや表示文字列がコンピューターの状態に応じて変化する場合は、idIconidNameidInfo の各メンバーに有効なリソース識別子を指定する代わりに、CPL_DYNAMIC_RES 値を指定できます。この場合、コントロール パネルは、アイコンと表示文字列が必要になるたびに CPL_NEWINQUIRE メッセージを送信します。ただし、この方法では、コントロール パネルが CPL_NEWINQUIRE メッセージを送信するたびにアプリケーションを読み込む必要があるため、処理速度が大幅に低下します。

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

各言語での定義

#include <windows.h>

// CPLINFO  (x64 20 / x86 16 バイト)
#pragma pack(push, 1)
typedef struct CPLINFO {
    INT idIcon;
    INT idName;
    INT idInfo;
    INT_PTR lData;
} CPLINFO;
#pragma pack(pop)
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, Pack = 1, CharSet = CharSet.Unicode)]
public struct CPLINFO
{
    public int idIcon;
    public int idName;
    public int idInfo;
    public IntPtr lData;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, Pack:=1, CharSet:=CharSet.Unicode)>
Public Structure CPLINFO
    Public idIcon As Integer
    Public idName As Integer
    Public idInfo As Integer
    Public lData As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class CPLINFO(ctypes.Structure):
    _pack_ = 1
    _fields_ = [
        ("idIcon", ctypes.c_int),
        ("idName", ctypes.c_int),
        ("idInfo", ctypes.c_int),
        ("lData", ctypes.c_ssize_t),
    ]
#[repr(C, packed(1))]
pub struct CPLINFO {
    pub idIcon: i32,
    pub idName: i32,
    pub idInfo: i32,
    pub lData: isize,
}
import "golang.org/x/sys/windows"

type CPLINFO struct {
	idIcon int32
	idName int32
	idInfo int32
	lData uintptr
}
type
  CPLINFO = packed record
    idIcon: Integer;
    idName: Integer;
    idInfo: Integer;
    lData: NativeInt;
  end;
const CPLINFO = extern struct {
    idIcon: i32,
    idName: i32,
    idInfo: i32,
    lData: isize,
};
type
  CPLINFO {.packed.} = object
    idIcon: int32
    idName: int32
    idInfo: int32
    lData: int
align(1)
struct CPLINFO
{
    int idIcon;
    int idName;
    int idInfo;
    ptrdiff_t lData;
}

HSP用 定義

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

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

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