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

HDITEMW

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

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

フィールド

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

他のどのメンバーが有効なデータを含んでいるか、または設定する必要があるかを示すフラグです。このメンバーには次の値の組み合わせを指定できます:

意味
HDI_BITMAP
hbm メンバーが有効です。
HDI_DI_SETITEM
HDM_GETITEM メッセージの処理中に、ヘッダーコントロールが要求を完了するために必要なすべての値を保持しているとは限りません。その場合、コントロールは HDN_GETDISPINFO 通知によってアプリケーションに値を問い合わせる必要があります。HDM_GETITEM メッセージで HDI_DI_SETITEM が渡されていた場合、コントロールは HDN_GETDISPINFO から返された値をキャッシュします (渡されていない場合、値は未設定のままになります)。
HDI_FORMAT
fmt メンバーが有効です。
HDI_FILTER
type メンバーと pvFilter メンバーが有効です。これは type メンバーで指定された値をフィルターするために使用されます。
HDI_HEIGHT
HDI_WIDTH と同じです。
HDI_IMAGE
                    <b>iImage</b> メンバーが有効であり、項目とともに表示される画像を指定します。
HDI_LPARAM
lParam メンバーが有効です。
HDI_ORDER
iOrder メンバーが有効であり、項目の順序値を指定します。
HDI_STATE

バージョン 6.00 以降state メンバーが有効です。

HDI_TEXT
pszText メンバーと cchTextMax メンバーが有効です。
HDI_WIDTH
cxy メンバーが有効であり、項目の幅を指定します。
cxyINT4+4+4項目の幅または高さです。
pszTextLPWSTR8/4+8+8項目の文字列へのポインターです。コントロールからテキストを取得する場合、このメンバーは文字バッファーを指すように初期化されていなければなりません。このメンバーに LPSTR_TEXTCALLBACK を設定すると、コントロールは HDN_GETDISPINFO 通知コードを送信して、この項目のテキスト情報を要求します。ヘッダーコントロールは任意の長さの文字列を項目テキストとして格納できますが、表示されるのは先頭の 260 TCHARs のみである点に注意してください。
hbmHBITMAP8/4+16+12項目のビットマップのハンドルです。
cchTextMaxINT4+24+16項目の文字列の長さ (TCHARs 単位) です。コントロールからテキストを取得する場合、このメンバーには pszText で指定されたアドレスにある TCHARs の数を格納しなければなりません。
fmtHEADER_CONTROL_FORMAT_FLAGS4+28+20

項目の表示形式を指定するフラグです。

意味
テキストの配置:
テキストの配置を指定するには、次のフラグのいずれかを設定します:
HDF_CENTER
項目の内容が中央揃えになります。
HDF_LEFT
項目の内容が左揃えになります。
HDF_RIGHT
項目の内容が右揃えになります。
表示:
表示を制御するには、次のフラグのいずれかを設定します:
HDF_BITMAP
項目にビットマップを表示します。
HDF_BITMAP_ON_RIGHT
ビットマップがテキストの右側に表示されます。
HDF_OWNERDRAW
ヘッダーコントロールのオーナーが項目を描画します。
HDF_STRING
項目に文字列を表示します。
フラグの組み合わせ:
上記の値は次の値と組み合わせることができます:
HDF_IMAGE
イメージリストの画像を表示します。イメージリストは HDM_SETIMAGELIST メッセージを送信して指定します。画像のインデックスは、この構造体の iImage メンバーで指定します。
HDF_JUSTIFYMASK
上の表に示した 3 つの配置フラグに対応するビットを取り出します。
HDF_RTLREADING
通常、ウィンドウはテキストを左から右 (LTR) に表示します。ウィンドウをミラー化すると、ヘブライ語やアラビア語のように右から左 (RTL) に読む言語を表示できます。通常、ヘッダーのテキストは親ウィンドウのテキストと同じ方向で読まれます。HDF_RTLREADING が設定されている場合、ヘッダーのテキストは親ウィンドウのテキストとは逆の方向で読まれます。
HDF_SORTDOWN

バージョン 6.00 以降。この項目に下向き矢印を描画します。これは通常、現在のウィンドウ内の情報がこの列で降順に並べ替えられていることを示すために使用されます。このフラグは HDF_IMAGEHDF_BITMAP と組み合わせることはできません。

HDF_SORTUP

バージョン 6.00 以降。この項目に上向き矢印を描画します。これは通常、現在のウィンドウ内の情報がこの列で昇順に並べ替えられていることを示すために使用されます。このフラグは HDF_IMAGEHDF_BITMAP と組み合わせることはできません。

HDF_CHECKBOX

バージョン 6.00 以降。項目にチェックボックスを表示します。このフラグは、ヘッダーコントロールに HDS_CHECKBOXES スタイルがあらかじめ設定されている場合にのみ有効です。

HDF_CHECKED

バージョン 6.00 以降。項目にチェック済みのチェックボックスを表示します。このフラグは HDF_CHECKBOX も設定されている場合にのみ有効です。

HDF_FIXEDWIDTH

バージョン 6.00 以降。ユーザーによるサイズ変更操作では項目の幅を変更できません。

HDF_SPLITBUTTON

バージョン 6.00 以降。 項目に分割ボタンを表示します。 分割ボタンがクリックされると HDN_DROPDOWN 通知が送信されます。

lParamLPARAM8/4+32+24アプリケーション定義の項目データです。
iImageINT4+40+28イメージリスト内の画像を示す 0 から始まるインデックスです。指定した画像は、hbm フィールドで指定された画像に加えてヘッダー項目に表示されます。iImageI_IMAGECALLBACK を設定すると、コントロールは HDN_GETDISPINFO 通知コードを使用して、この項目のテキスト情報を要求します。画像を消去するには、この値を I_IMAGENONE に設定します。
iOrderINT4+44+32ヘッダーコントロール内で項目が左から右に並ぶ順序です。つまり、最も左の項目の値は 0 になります。その右隣の項目の値は 1 となり、以降も同様です。
typeHEADER_CONTROL_FORMAT_TYPE4+48+36

pvFilter で指定されるフィルターの種類です。指定できる種類は次のとおりです:

意味
HDFT_ISSTRING
文字列データです。
HDFT_ISNUMBER
数値データです。
HDFT_HASNOVALUE
pvFilter を無視します。
HDFT_ISDATE

バージョン 6.00 以降。日付データです。pvFilter メンバーは SYSTEMTIME 構造体へのポインターです。

pvFiltervoid*8/4+56+40アプリケーション定義のデータ項目のアドレスです。データのフィルターの種類は、メンバーにフラグ値を設定することで決まります。文字列を示すには HDFT_ISSTRING フラグを、整数を示すには HDFT_ISNUMBER を使用します。HDFT_ISSTRING フラグを使用する場合、pvFilterHDTEXTFILTER 構造体へのポインターになります。
stateHEADER_CONTROL_FORMAT_STATE4+64+44

状態です。このメンバーで有効かつサポートされる値は、次のもののみです:

意味
HDIS_FOCUSED
項目がキーボードフォーカスを持っています。

公式ドキュメント

ヘッダーコントロール内の項目に関する情報を格納します。この構造体は HD_ITEM 構造体に代わるものです。

解説(Remarks)

注意 Comctl32.dll バージョン 6 は再頒布可能ではありませんが、Windows に含まれています。Comctl32.dll バージョン 6 を使用するには、マニフェストで指定します。マニフェストの詳細については、ビジュアルスタイルの有効化を参照してください。
メモ

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

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

各言語での定義

#include <windows.h>

// HDITEMW  (x64 72 / x86 48 バイト)
typedef struct HDITEMW {
    HDI_MASK mask;
    INT cxy;
    LPWSTR pszText;
    HBITMAP hbm;
    INT cchTextMax;
    HEADER_CONTROL_FORMAT_FLAGS fmt;
    LPARAM lParam;
    INT iImage;
    INT iOrder;
    HEADER_CONTROL_FORMAT_TYPE type;
    void* pvFilter;
    HEADER_CONTROL_FORMAT_STATE state;
} HDITEMW;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct HDITEMW
{
    public uint mask;
    public int cxy;
    public IntPtr pszText;
    public IntPtr hbm;
    public int cchTextMax;
    public int fmt;
    public IntPtr lParam;
    public int iImage;
    public int iOrder;
    public uint type;
    public IntPtr pvFilter;
    public uint state;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure HDITEMW
    Public mask As UInteger
    Public cxy As Integer
    Public pszText As IntPtr
    Public hbm As IntPtr
    Public cchTextMax As Integer
    Public fmt As Integer
    Public lParam As IntPtr
    Public iImage As Integer
    Public iOrder As Integer
    Public type As UInteger
    Public pvFilter As IntPtr
    Public state As UInteger
End Structure
import ctypes
from ctypes import wintypes

class HDITEMW(ctypes.Structure):
    _fields_ = [
        ("mask", wintypes.DWORD),
        ("cxy", ctypes.c_int),
        ("pszText", ctypes.c_void_p),
        ("hbm", ctypes.c_void_p),
        ("cchTextMax", ctypes.c_int),
        ("fmt", ctypes.c_int),
        ("lParam", ctypes.c_ssize_t),
        ("iImage", ctypes.c_int),
        ("iOrder", ctypes.c_int),
        ("type", wintypes.DWORD),
        ("pvFilter", ctypes.c_void_p),
        ("state", wintypes.DWORD),
    ]
#[repr(C)]
pub struct HDITEMW {
    pub mask: u32,
    pub cxy: i32,
    pub pszText: *mut core::ffi::c_void,
    pub hbm: *mut core::ffi::c_void,
    pub cchTextMax: i32,
    pub fmt: i32,
    pub lParam: isize,
    pub iImage: i32,
    pub iOrder: i32,
    pub type: u32,
    pub pvFilter: *mut core::ffi::c_void,
    pub state: u32,
}
import "golang.org/x/sys/windows"

type HDITEMW struct {
	mask uint32
	cxy int32
	pszText uintptr
	hbm uintptr
	cchTextMax int32
	fmt int32
	lParam uintptr
	iImage int32
	iOrder int32
	type uint32
	pvFilter uintptr
	state uint32
}
type
  HDITEMW = record
    mask: DWORD;
    cxy: Integer;
    pszText: Pointer;
    hbm: Pointer;
    cchTextMax: Integer;
    fmt: Integer;
    lParam: NativeInt;
    iImage: Integer;
    iOrder: Integer;
    type: DWORD;
    pvFilter: Pointer;
    state: DWORD;
  end;
const HDITEMW = extern struct {
    mask: u32,
    cxy: i32,
    pszText: ?*anyopaque,
    hbm: ?*anyopaque,
    cchTextMax: i32,
    fmt: i32,
    lParam: isize,
    iImage: i32,
    iOrder: i32,
    type: u32,
    pvFilter: ?*anyopaque,
    state: u32,
};
type
  HDITEMW {.bycopy.} = object
    mask: uint32
    cxy: int32
    pszText: pointer
    hbm: pointer
    cchTextMax: int32
    fmt: int32
    lParam: int
    iImage: int32
    iOrder: int32
    type: uint32
    pvFilter: pointer
    state: uint32
struct HDITEMW
{
    uint mask;
    int cxy;
    void* pszText;
    void* hbm;
    int cchTextMax;
    int fmt;
    ptrdiff_t lParam;
    int iImage;
    int iOrder;
    uint type;
    void* pvFilter;
    uint state;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; HDITEMW サイズ: 48 バイト(x86)
dim st, 12    ; 4byte整数×12(構造体サイズ 48 / 4 切り上げ)
; mask : HDI_MASK (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; cxy : INT (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; pszText : LPWSTR (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; hbm : HBITMAP (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; cchTextMax : INT (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; fmt : HEADER_CONTROL_FORMAT_FLAGS (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; lParam : LPARAM (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; iImage : INT (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; iOrder : INT (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; type : HEADER_CONTROL_FORMAT_TYPE (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; pvFilter : void* (+40, 4byte)  st.10 = 値  /  値 = st.10   (lpoke/lpeek も可)
; state : HEADER_CONTROL_FORMAT_STATE (+44, 4byte)  st.11 = 値  /  値 = st.11   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; HDITEMW サイズ: 72 バイト(x64)
dim st, 18    ; 4byte整数×18(構造体サイズ 72 / 4 切り上げ)
; mask : HDI_MASK (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; cxy : INT (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; pszText : LPWSTR (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; hbm : HBITMAP (+16, 8byte)  qpoke st,16,値 / qpeek(st,16)  ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; cchTextMax : INT (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; fmt : HEADER_CONTROL_FORMAT_FLAGS (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; lParam : LPARAM (+32, 8byte)  qpoke st,32,値 / qpeek(st,32)  ※IronHSPのみ。3.7/3.8は lpoke st,32,下位 : lpoke st,36,上位
; iImage : INT (+40, 4byte)  st.10 = 値  /  値 = st.10   (lpoke/lpeek も可)
; iOrder : INT (+44, 4byte)  st.11 = 値  /  値 = st.11   (lpoke/lpeek も可)
; type : HEADER_CONTROL_FORMAT_TYPE (+48, 4byte)  st.12 = 値  /  値 = st.12   (lpoke/lpeek も可)
; pvFilter : void* (+56, 8byte)  qpoke st,56,値 / qpeek(st,56)  ※IronHSPのみ。3.7/3.8は lpoke st,56,下位 : lpoke st,60,上位
; state : HEADER_CONTROL_FORMAT_STATE (+64, 4byte)  st.16 = 値  /  値 = st.16   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global HDITEMW
    #field int mask
    #field int cxy
    #field intptr pszText
    #field intptr hbm
    #field int cchTextMax
    #field int fmt
    #field intptr lParam
    #field int iImage
    #field int iOrder
    #field int type
    #field intptr pvFilter
    #field int state
#endstruct

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