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

TVITEMEXW

構造体
サイズx64: 80 バイト / x86: 60 バイト

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

フィールド

フィールドサイズx64x86説明
maskTVITEM_MASK4+0+0

他のどのメンバーが有効なデータを含んでいるかを示すフラグの配列です。この構造体を TVM_GETITEM メッセージで使用する場合、mask メンバーは取得する項目の属性を示します。TVM_SETITEM メッセージで使用する場合、mask は設定する属性を示します。このメンバーには次の値の 1 つ以上を指定できます:

意味
TVIF_CHILDREN
cChildren メンバーが有効です。
TVIF_DI_SETITEM
ツリービューコントロールは指定された情報を保持し、再度要求しません。このフラグは TVN_GETDISPINFO 通知の処理中にのみ有効です。
TVIF_EXPANDEDIMAGE

バージョン 6.00 および Windows Vista。 iExpandedImage メンバーが有効です。

TVIF_HANDLE
hItem メンバーが有効です。
TVIF_IMAGE
iImage メンバーが有効です。
TVIF_INTEGRAL
iIntegral メンバーが有効です。
TVIF_PARAM
lParam メンバーが有効です。
TVIF_SELECTEDIMAGE
iSelectedImage メンバーが有効です。
TVIF_STATE
state メンバーと stateMask メンバーが有効です。
TVIF_STATEEX

バージョン 6.00 および Windows Vista。 uStateEx メンバーが有効です。

TVIF_TEXT
pszText メンバーと cchTextMax メンバーが有効です。
hItemHTREEITEM8/4+8+4項目のハンドルです。
stateDWORD4+16+8

項目の状態を示すビットフラグとイメージリストのインデックスの組み合わせです。項目の状態を設定するときは、stateMask メンバーがこのメンバーの有効なビットを示します。項目の状態を取得するときは、このメンバーは stateMask メンバーで示されたビットについての現在の状態を返します。 このメンバーの詳細については、解説セクションを参照してください。

このメンバーのビット 0 から 7 には、項目の状態フラグが格納されます。指定できる項目の状態フラグの一覧については、ツリービューコントロールの項目の状態を参照してください。

このメンバーのビット 8 から 11 は、1 から始まるオーバーレイイメージのインデックスを指定します。オーバーレイイメージは項目のアイコンイメージに重ねて表示されます。これらのビットが 0 の場合、その項目にオーバーレイイメージはありません。これらのビットを取り出すには、TVIS_OVERLAYMASK マスクを使用します。このメンバーにオーバーレイイメージのインデックスを設定するには、INDEXTOOVERLAYMASK マクロを使用します。イメージリストのオーバーレイイメージは ImageList_SetOverlayImage 関数で設定します。

状態イメージは、アプリケーション定義の状態を示すために項目のアイコンの隣に表示されます。状態イメージリストを指定するには、TVM_SETIMAGELIST メッセージを送信します。項目の状態イメージを設定するには、TVITEM 構造体の stateMask メンバーに TVIS_STATEIMAGEMASK 値を含めます。この構造体の state メンバーのビット 12 から 15 が、描画するイメージの状態イメージリスト内でのインデックスを指定します。

状態イメージのインデックスを設定するには、INDEXTOSTATEIMAGEMASK を使用します。このマクロはインデックスを受け取り、ビット 12 から 15 を適切に設定します。項目に状態イメージがないことを示すには、インデックスを 0 に設定します。この規約により、状態イメージリストのインデックス 0 のイメージは状態イメージとして使用できません。state メンバーのビット 12 から 15 を取り出すには、TVIS_STATEIMAGEMASK マスクを使用します。

stateMaskDWORD4+20+12state メンバーのうち有効なビットです。項目の状態を取得する場合は、state メンバーで返してほしいビットを示すように stateMask メンバーのビットを設定します。項目の状態を設定する場合は、設定したい state メンバーのビットを示すように stateMask メンバーのビットを設定します。項目のオーバーレイイメージのインデックスを設定または取得するには、TVIS_OVERLAYMASK のビットを設定します。項目の状態イメージのインデックスを設定または取得するには、TVIS_STATEIMAGEMASK のビットを設定します。
pszTextLPWSTR8/4+24+16この構造体が項目の属性を指定する場合は、項目のテキストを格納した null 終端文字列へのポインターです。このメンバーが LPSTR_TEXTCALLBACK 値の場合、名前の保持は親ウィンドウが担当します。この場合、ツリービューコントロールは、表示・並べ替え・編集のために項目のテキストが必要になったときに親ウィンドウへ TVN_GETDISPINFO 通知コードを送信し、項目のテキストが変更されたときには TVN_SETDISPINFO 通知コードを送信します。この構造体が項目の属性を受け取る場合、このメンバーは項目のテキストを受け取るバッファーのアドレスです。ツリービューコントロールは任意の長さの文字列を項目のテキストとして保持できますが、表示されるのは先頭の 260 文字のみである点に注意してください。
cchTextMaxINT4+32+20pszText メンバーが指すバッファーのサイズ (文字単位)。この構造体を項目の属性の設定に使用する場合、このメンバーは無視されます。
iImageINT4+36+24項目が非選択状態のときに使用するアイコンイメージの、ツリービューコントロールのイメージリスト内でのインデックスです。このメンバーが I_IMAGECALLBACK 値の場合、インデックスの保持は親ウィンドウが担当します。この場合、ツリービューコントロールは、イメージを表示する必要があるときにインデックスを取得するため、親へ TVN_GETDISPINFO 通知コードを送信します。
iSelectedImageINT4+40+28項目が選択状態のときに使用するアイコンイメージの、ツリービューコントロールのイメージリスト内でのインデックスです。このメンバーが I_IMAGECALLBACK 値の場合、インデックスの保持は親ウィンドウが担当します。この場合、ツリービューコントロールは、イメージを表示する必要があるときにインデックスを取得するため、親へ TVN_GETDISPINFO 通知コードを送信します。
cChildrenTVITEMEXW_CHILDREN4+44+32

項目に子項目が関連付けられているかどうかを示すフラグです。このメンバーには次のいずれかの値を指定できます:

意味
0
項目に子項目はありません。
1
項目に 1 つ以上の子項目があります。
I_CHILDRENCALLBACK
項目に子項目があるかどうかは親ウィンドウが管理します。この場合、ツリービューコントロールは、項目を表示する必要があるときに、項目に子項目があるかどうかを判断するため親へ TVN_GETDISPINFO 通知コードを送信します。ツリービューコントロールに TVS_HASBUTTONS スタイルが設定されている場合、コントロールはこのメンバーを使用して、子項目の存在を示すボタンを表示するかどうかを判断します。このメンバーを使用すると、実際には子項目が挿入されていなくてもボタンを強制的に表示できます。これにより、項目が表示されたときや展開されたときにのみ子項目を挿入することで、コントロールのメモリ使用量を抑えながらボタンを表示できます。
I_CHILDRENAUTO

バージョン 6.0 内部使用を意図したものであり、アプリケーションでの使用は推奨されません。 ツリービューコントロールが、項目に子項目があるかどうかを自動的に判断します。

注意 このフラグは、今後のバージョンの Comctl32.dll ではサポートされない可能性があります。また、このフラグは commctrl.h では定義されていません。このフラグを使用するには、アプリケーションのソースファイルに次の定義を追加してください:
#define I_CHILDRENAUTO (-2)
lParamLPARAM8/4+48+36項目に関連付ける値です。
iIntegralINT4+56+40標準の項目の高さ (TVM_SETITEMHEIGHT を参照) の倍数で表した、項目の高さです。たとえば、このメンバーに 2 を設定すると、項目の高さは標準の 2 倍になります。ツリービューコントロールは、項目の内容の下に生じるこの余分な領域には描画しませんが、カスタム描画を使用する場合、アプリケーションはこの領域を描画に利用できます。カスタム描画を使用しないアプリケーションでは、この値に 1 を設定してください。そうしない場合の動作は未定義です。
uStateExDWORD4+60+44

Internet Explorer 6 以降。次の拡張状態のうち 1 つ以上 (ビット単位の組み合わせ) を指定します。

意味
TVIS_EX_DISABLED
Windows Vista 以降。灰色で描画され、ユーザーが操作できないコントロールを作成します。
TVIS_EX_FLAT
フラットな項目を作成します。この項目は仮想的なもので、ツリーには表示されません。代わりに、その子項目がツリー階層内でその位置を占めます。この状態は、ツリービューコントロールに項目を追加するときにのみ有効です。
TVIS_EX_HWND
項目用に個別の HWND を作成します。この状態は、ツリービューコントロールに項目を追加するときにのみ有効です。
hwndHWND8/4+64+48Internet Explorer 6 以降。使用されません。NULL でなければなりません。
iExpandedImageINT4+72+52Internet Explorer 6 以降。項目が展開状態のときに表示する、コントロールのイメージリスト内のイメージのインデックスです。
iReservedINT4+76+56予約済みのメンバーです。使用しないでください。

公式ドキュメント

ツリービュー項目の属性を指定または受け取ります。この構造体は TVITEM 構造体を拡張したものです。新しいアプリケーションでは、適切な場合にこの構造体を使用してください。

解説(Remarks)

メモ

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

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

各言語での定義

#include <windows.h>

// TVITEMEXW  (x64 80 / x86 60 バイト)
typedef struct TVITEMEXW {
    TVITEM_MASK mask;
    HTREEITEM hItem;
    DWORD state;
    DWORD stateMask;
    LPWSTR pszText;
    INT cchTextMax;
    INT iImage;
    INT iSelectedImage;
    TVITEMEXW_CHILDREN cChildren;
    LPARAM lParam;
    INT iIntegral;
    DWORD uStateEx;
    HWND hwnd;
    INT iExpandedImage;
    INT iReserved;
} TVITEMEXW;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct TVITEMEXW
{
    public uint mask;
    public IntPtr hItem;
    public uint state;
    public uint stateMask;
    public IntPtr pszText;
    public int cchTextMax;
    public int iImage;
    public int iSelectedImage;
    public int cChildren;
    public IntPtr lParam;
    public int iIntegral;
    public uint uStateEx;
    public IntPtr hwnd;
    public int iExpandedImage;
    public int iReserved;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure TVITEMEXW
    Public mask As UInteger
    Public hItem As IntPtr
    Public state As UInteger
    Public stateMask As UInteger
    Public pszText As IntPtr
    Public cchTextMax As Integer
    Public iImage As Integer
    Public iSelectedImage As Integer
    Public cChildren As Integer
    Public lParam As IntPtr
    Public iIntegral As Integer
    Public uStateEx As UInteger
    Public hwnd As IntPtr
    Public iExpandedImage As Integer
    Public iReserved As Integer
End Structure
import ctypes
from ctypes import wintypes

class TVITEMEXW(ctypes.Structure):
    _fields_ = [
        ("mask", wintypes.DWORD),
        ("hItem", ctypes.c_ssize_t),
        ("state", wintypes.DWORD),
        ("stateMask", wintypes.DWORD),
        ("pszText", ctypes.c_void_p),
        ("cchTextMax", ctypes.c_int),
        ("iImage", ctypes.c_int),
        ("iSelectedImage", ctypes.c_int),
        ("cChildren", ctypes.c_int),
        ("lParam", ctypes.c_ssize_t),
        ("iIntegral", ctypes.c_int),
        ("uStateEx", wintypes.DWORD),
        ("hwnd", ctypes.c_void_p),
        ("iExpandedImage", ctypes.c_int),
        ("iReserved", ctypes.c_int),
    ]
#[repr(C)]
pub struct TVITEMEXW {
    pub mask: u32,
    pub hItem: isize,
    pub state: u32,
    pub stateMask: u32,
    pub pszText: *mut core::ffi::c_void,
    pub cchTextMax: i32,
    pub iImage: i32,
    pub iSelectedImage: i32,
    pub cChildren: i32,
    pub lParam: isize,
    pub iIntegral: i32,
    pub uStateEx: u32,
    pub hwnd: *mut core::ffi::c_void,
    pub iExpandedImage: i32,
    pub iReserved: i32,
}
import "golang.org/x/sys/windows"

type TVITEMEXW struct {
	mask uint32
	hItem uintptr
	state uint32
	stateMask uint32
	pszText uintptr
	cchTextMax int32
	iImage int32
	iSelectedImage int32
	cChildren int32
	lParam uintptr
	iIntegral int32
	uStateEx uint32
	hwnd uintptr
	iExpandedImage int32
	iReserved int32
}
type
  TVITEMEXW = record
    mask: DWORD;
    hItem: NativeInt;
    state: DWORD;
    stateMask: DWORD;
    pszText: Pointer;
    cchTextMax: Integer;
    iImage: Integer;
    iSelectedImage: Integer;
    cChildren: Integer;
    lParam: NativeInt;
    iIntegral: Integer;
    uStateEx: DWORD;
    hwnd: Pointer;
    iExpandedImage: Integer;
    iReserved: Integer;
  end;
const TVITEMEXW = extern struct {
    mask: u32,
    hItem: isize,
    state: u32,
    stateMask: u32,
    pszText: ?*anyopaque,
    cchTextMax: i32,
    iImage: i32,
    iSelectedImage: i32,
    cChildren: i32,
    lParam: isize,
    iIntegral: i32,
    uStateEx: u32,
    hwnd: ?*anyopaque,
    iExpandedImage: i32,
    iReserved: i32,
};
type
  TVITEMEXW {.bycopy.} = object
    mask: uint32
    hItem: int
    state: uint32
    stateMask: uint32
    pszText: pointer
    cchTextMax: int32
    iImage: int32
    iSelectedImage: int32
    cChildren: int32
    lParam: int
    iIntegral: int32
    uStateEx: uint32
    hwnd: pointer
    iExpandedImage: int32
    iReserved: int32
struct TVITEMEXW
{
    uint mask;
    ptrdiff_t hItem;
    uint state;
    uint stateMask;
    void* pszText;
    int cchTextMax;
    int iImage;
    int iSelectedImage;
    int cChildren;
    ptrdiff_t lParam;
    int iIntegral;
    uint uStateEx;
    void* hwnd;
    int iExpandedImage;
    int iReserved;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; TVITEMEXW サイズ: 60 バイト(x86)
dim st, 15    ; 4byte整数×15(構造体サイズ 60 / 4 切り上げ)
; mask : TVITEM_MASK (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; hItem : HTREEITEM (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; state : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; stateMask : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; pszText : LPWSTR (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; cchTextMax : INT (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; iImage : INT (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; iSelectedImage : INT (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; cChildren : TVITEMEXW_CHILDREN (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; lParam : LPARAM (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; iIntegral : INT (+40, 4byte)  st.10 = 値  /  値 = st.10   (lpoke/lpeek も可)
; uStateEx : DWORD (+44, 4byte)  st.11 = 値  /  値 = st.11   (lpoke/lpeek も可)
; hwnd : HWND (+48, 4byte)  st.12 = 値  /  値 = st.12   (lpoke/lpeek も可)
; iExpandedImage : INT (+52, 4byte)  st.13 = 値  /  値 = st.13   (lpoke/lpeek も可)
; iReserved : INT (+56, 4byte)  st.14 = 値  /  値 = st.14   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; TVITEMEXW サイズ: 80 バイト(x64)
dim st, 20    ; 4byte整数×20(構造体サイズ 80 / 4 切り上げ)
; mask : TVITEM_MASK (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; hItem : HTREEITEM (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; state : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; stateMask : DWORD (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; pszText : LPWSTR (+24, 8byte)  qpoke st,24,値 / qpeek(st,24)  ※IronHSPのみ。3.7/3.8は lpoke st,24,下位 : lpoke st,28,上位
; cchTextMax : INT (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; iImage : INT (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; iSelectedImage : INT (+40, 4byte)  st.10 = 値  /  値 = st.10   (lpoke/lpeek も可)
; cChildren : TVITEMEXW_CHILDREN (+44, 4byte)  st.11 = 値  /  値 = st.11   (lpoke/lpeek も可)
; lParam : LPARAM (+48, 8byte)  qpoke st,48,値 / qpeek(st,48)  ※IronHSPのみ。3.7/3.8は lpoke st,48,下位 : lpoke st,52,上位
; iIntegral : INT (+56, 4byte)  st.14 = 値  /  値 = st.14   (lpoke/lpeek も可)
; uStateEx : DWORD (+60, 4byte)  st.15 = 値  /  値 = st.15   (lpoke/lpeek も可)
; hwnd : HWND (+64, 8byte)  qpoke st,64,値 / qpeek(st,64)  ※IronHSPのみ。3.7/3.8は lpoke st,64,下位 : lpoke st,68,上位
; iExpandedImage : INT (+72, 4byte)  st.18 = 値  /  値 = st.18   (lpoke/lpeek も可)
; iReserved : INT (+76, 4byte)  st.19 = 値  /  値 = st.19   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global TVITEMEXW
    #field int mask
    #field intptr hItem
    #field int state
    #field int stateMask
    #field intptr pszText
    #field int cchTextMax
    #field int iImage
    #field int iSelectedImage
    #field int cChildren
    #field intptr lParam
    #field int iIntegral
    #field int uStateEx
    #field intptr hwnd
    #field int iExpandedImage
    #field int iReserved
#endstruct

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