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

TBBUTTONINFOW

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

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

フィールド

フィールドサイズx64x86説明
cbSizeDWORD4+0+0構造体のサイズ (バイト単位)。このメンバーは、関連するメッセージを送信する前に設定しておく必要があります。
dwMaskTBBUTTONINFOW_MASK4+4+4

どのメンバーに有効な情報が含まれているかを示すフラグのセット。このメンバーは、関連するメッセージを送信する前に設定しておく必要があります。次の値の 1 つ以上を指定できます。

意味
TBIF_BYINDEX

バージョン 5.80。 TB_GETBUTTONINFO または TB_SETBUTTONINFO メッセージとともに送信される wParam は、識別子ではなくインデックスです。

TBIF_COMMAND
idCommand メンバーに有効な情報が含まれている、またはその情報が要求されています。
TBIF_IMAGE
iImage メンバーに有効な情報が含まれている、またはその情報が要求されています。
TBIF_LPARAM
lParam メンバーに有効な情報が含まれている、またはその情報が要求されています。
TBIF_SIZE
cx メンバーに有効な情報が含まれている、またはその情報が要求されています。
TBIF_STATE
fsState メンバーに有効な情報が含まれている、またはその情報が要求されています。
TBIF_STYLE
fsStyle メンバーに有効な情報が含まれている、またはその情報が要求されています。
TBIF_TEXT
pszText メンバーに有効な情報が含まれている、またはその情報が要求されています。
idCommandINT4+8+8ボタンのコマンド識別子。
iImageINT4+12+12

ボタンのイメージインデックス。このメンバーに I_IMAGECALLBACK を設定すると、ツールバーは必要になった時点で TBN_GETDISPINFO 通知コードを送信してイメージインデックスを取得します。

バージョン 5.81。このメンバーに I_IMAGENONE を設定すると、ボタンにイメージがないことを示します。ボタンのレイアウトにはビットマップ用の領域は含まれず、テキストのみになります。

fsStateBYTE1+16+16ボタンの状態フラグ。Toolbar Button States に列挙されている値の 1 つ以上を指定できます。
fsStyleBYTE1+17+17ボタンのスタイルフラグ。Toolbar Control and Button Styles に列挙されている値の 1 つ以上を指定できます。
cxWORD2+18+18ボタンの幅 (ピクセル単位)。
lParamUINT_PTR8/4+24+20ボタンに関連付けられた、アプリケーション定義の値。
pszTextLPWSTR8/4+32+24ボタンのテキストを格納または受け取る文字バッファーのアドレス。
cchTextINT4+40+28pszText が指すバッファーのサイズ。ボタン情報を設定する場合、このメンバーは無視されます。

公式ドキュメント

ツールバー内の特定のボタンに関する情報を格納または受け取ります。

解説(Remarks)

メモ

commctrl.h ヘッダーは、UNICODE プリプロセッサー定数の定義に基づいてこの関数の ANSI 版と Unicode 版を自動的に選択するエイリアスとして TBBUTTONINFO を定義しています。エンコーディング中立のエイリアスと、エンコーディング中立ではないコードを混在させると不整合が生じ、コンパイルエラーや実行時エラーの原因になることがあります。詳細については、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>

// TBBUTTONINFOW  (x64 48 / x86 32 バイト)
typedef struct TBBUTTONINFOW {
    DWORD cbSize;
    TBBUTTONINFOW_MASK dwMask;
    INT idCommand;
    INT iImage;
    BYTE fsState;
    BYTE fsStyle;
    WORD cx;
    UINT_PTR lParam;
    LPWSTR pszText;
    INT cchText;
} TBBUTTONINFOW;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct TBBUTTONINFOW
{
    public uint cbSize;
    public uint dwMask;
    public int idCommand;
    public int iImage;
    public byte fsState;
    public byte fsStyle;
    public ushort cx;
    public UIntPtr lParam;
    public IntPtr pszText;
    public int cchText;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure TBBUTTONINFOW
    Public cbSize As UInteger
    Public dwMask As UInteger
    Public idCommand As Integer
    Public iImage As Integer
    Public fsState As Byte
    Public fsStyle As Byte
    Public cx As UShort
    Public lParam As UIntPtr
    Public pszText As IntPtr
    Public cchText As Integer
End Structure
import ctypes
from ctypes import wintypes

class TBBUTTONINFOW(ctypes.Structure):
    _fields_ = [
        ("cbSize", wintypes.DWORD),
        ("dwMask", wintypes.DWORD),
        ("idCommand", ctypes.c_int),
        ("iImage", ctypes.c_int),
        ("fsState", ctypes.c_ubyte),
        ("fsStyle", ctypes.c_ubyte),
        ("cx", ctypes.c_ushort),
        ("lParam", ctypes.c_size_t),
        ("pszText", ctypes.c_void_p),
        ("cchText", ctypes.c_int),
    ]
#[repr(C)]
pub struct TBBUTTONINFOW {
    pub cbSize: u32,
    pub dwMask: u32,
    pub idCommand: i32,
    pub iImage: i32,
    pub fsState: u8,
    pub fsStyle: u8,
    pub cx: u16,
    pub lParam: usize,
    pub pszText: *mut core::ffi::c_void,
    pub cchText: i32,
}
import "golang.org/x/sys/windows"

type TBBUTTONINFOW struct {
	cbSize uint32
	dwMask uint32
	idCommand int32
	iImage int32
	fsState byte
	fsStyle byte
	cx uint16
	lParam uintptr
	pszText uintptr
	cchText int32
}
type
  TBBUTTONINFOW = record
    cbSize: DWORD;
    dwMask: DWORD;
    idCommand: Integer;
    iImage: Integer;
    fsState: Byte;
    fsStyle: Byte;
    cx: Word;
    lParam: NativeUInt;
    pszText: Pointer;
    cchText: Integer;
  end;
const TBBUTTONINFOW = extern struct {
    cbSize: u32,
    dwMask: u32,
    idCommand: i32,
    iImage: i32,
    fsState: u8,
    fsStyle: u8,
    cx: u16,
    lParam: usize,
    pszText: ?*anyopaque,
    cchText: i32,
};
type
  TBBUTTONINFOW {.bycopy.} = object
    cbSize: uint32
    dwMask: uint32
    idCommand: int32
    iImage: int32
    fsState: uint8
    fsStyle: uint8
    cx: uint16
    lParam: uint
    pszText: pointer
    cchText: int32
struct TBBUTTONINFOW
{
    uint cbSize;
    uint dwMask;
    int idCommand;
    int iImage;
    ubyte fsState;
    ubyte fsStyle;
    ushort cx;
    size_t lParam;
    void* pszText;
    int cchText;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; TBBUTTONINFOW サイズ: 32 バイト(x86)
dim st, 8    ; 4byte整数×8(構造体サイズ 32 / 4 切り上げ)
; cbSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwMask : TBBUTTONINFOW_MASK (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; idCommand : INT (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; iImage : INT (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; fsState : BYTE (+16, 1byte)  poke st,16,値  /  値 = peek(st,16)
; fsStyle : BYTE (+17, 1byte)  poke st,17,値  /  値 = peek(st,17)
; cx : WORD (+18, 2byte)  wpoke st,18,値  /  値 = wpeek(st,18)
; lParam : UINT_PTR (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; pszText : LPWSTR (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; cchText : INT (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; TBBUTTONINFOW サイズ: 48 バイト(x64)
dim st, 12    ; 4byte整数×12(構造体サイズ 48 / 4 切り上げ)
; cbSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwMask : TBBUTTONINFOW_MASK (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; idCommand : INT (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; iImage : INT (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; fsState : BYTE (+16, 1byte)  poke st,16,値  /  値 = peek(st,16)
; fsStyle : BYTE (+17, 1byte)  poke st,17,値  /  値 = peek(st,17)
; cx : WORD (+18, 2byte)  wpoke st,18,値  /  値 = wpeek(st,18)
; lParam : UINT_PTR (+24, 8byte)  qpoke st,24,値 / qpeek(st,24)  ※IronHSPのみ。3.7/3.8は lpoke st,24,下位 : lpoke st,28,上位
; pszText : LPWSTR (+32, 8byte)  qpoke st,32,値 / qpeek(st,32)  ※IronHSPのみ。3.7/3.8は lpoke st,32,下位 : lpoke st,36,上位
; cchText : INT (+40, 4byte)  st.10 = 値  /  値 = st.10   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global TBBUTTONINFOW
    #field int cbSize
    #field int dwMask
    #field int idCommand
    #field int iImage
    #field byte fsState
    #field byte fsStyle
    #field short cx
    #field intptr lParam
    #field intptr pszText
    #field int cchText
#endstruct

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