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

LVBKIMAGEA

構造体
サイズx64: 40 バイト / x86: 24 バイト

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

フィールド

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

このメンバーには、次のフラグを 1 つ以上指定できます。LVBKIF_SOURCE_MASK 値を使用すると、ソースフラグ以外をマスクできます。LVBKIF_STYLE_MASK 値を使用すると、スタイルフラグ以外をマスクできます。

意味
LVBKIF_SOURCE_NONE
リストビューコントロールに背景イメージはありません。
LVBKIF_SOURCE_HBITMAP
背景ビットマップは LVBKIMAGEhbm メンバーで指定します。LVM_SETBKIMAGE メッセージが成功すると、リストビューがそのビットマップの所有権を取得します。
LVBKIF_SOURCE_URL
pszImage メンバーに背景イメージの URL が格納されます。
LVBKIF_STYLE_NORMAL
背景イメージが通常どおりに表示されます。
LVBKIF_STYLE_TILE
背景イメージが、コントロールの背景全体を埋めるように並べて (タイル状に) 表示されます。
LVBKIF_FLAG_TILEOFFSET
最初のタイルの座標を指定します。このフラグは、LVBKIF_STYLE_TILE フラグも指定されている場合にのみ有効です。このフラグを指定しない場合、最初のタイルはクライアント領域の左上隅から開始します。ComCtl32.dll バージョン 6.0 を使用する場合、xOffsetPercent フィールドと yOffsetPercent フィールドには、最初のタイルの座標を指定するための値として、パーセンテージではなくピクセル値を格納します。Comctl32.dll バージョン 6 は再頒布できませんが、Windows 以降に含まれています。また、マニフェストで Comctl32.dll バージョン 6 を指定する必要があります。マニフェストの詳細については、ビジュアルスタイルの有効化を参照してください。
LVBKIF_TYPE_WATERMARK
ウォーターマークの背景ビットマップは LVBKIMAGEhbm メンバーで指定します。LVM_SETBKIMAGE メッセージが成功すると、リストビューコントロールがそのビットマップの所有権を取得します。
LVBKIF_FLAG_ALPHABLEND
LVBKIF_TYPE_WATERMARK も指定されている場合にのみ有効です。このフラグは、LVBKIF_TYPE_WATERMARK で指定されたビットマップに有効なアルファチャネルが含まれていることを示します。
hbmHBITMAP8/4+8+4背景ビットマップのハンドルです。このメンバーは、ulFlagsLVBKIF_SOURCE_HBITMAP フラグが設定されている場合にのみ有効です。
pszImageLPSTR8/4+16+8背景イメージの URL を格納する、NULL で終わる文字列のアドレスです。このメンバーは、ulFlagsLVBKIF_SOURCE_URL フラグが設定されている場合にのみ有効です。このメンバーは、メッセージを送信する前に、テキストを格納する、またはテキストを受け取るバッファーを指すように初期化しておく必要があります。
cchImageMaxDWORD4+24+12pszImage が指すバッファーのサイズです。コントロールへ情報を送信する場合、このメンバーは無視されます。
xOffsetPercentINT4+28+16イメージを水平方向にオフセットする量を、コントロールのクライアント領域に対する割合 (パーセント) で指定します。たとえば 0 パーセントの場合、イメージはコントロールのクライアント領域の左端に接して表示されます。50 パーセントの場合、イメージはコントロールのクライアント領域内で水平方向に中央揃えで表示されます。100 パーセントの場合、イメージはコントロールのクライアント領域の右端に接して表示されます。このメンバーは、ulFlagsLVBKIF_STYLE_NORMAL が指定されている場合にのみ有効です。ulFlagsLVBKIF_FLAG_TILEOFFSETLVBKIF_STYLE_TILE の両方が指定されている場合、この値は最初のタイルのオフセットを、パーセンテージではなくピクセル単位で指定します。それ以外の場合、この値は無視されます。
yOffsetPercentINT4+32+20イメージを垂直方向にオフセットする量を、コントロールのクライアント領域に対する割合 (パーセント) で指定します。たとえば 0 パーセントの場合、イメージはコントロールのクライアント領域の上端に接して表示されます。50 パーセントの場合、イメージはコントロールのクライアント領域内で垂直方向に中央揃えで表示されます。100 パーセントの場合、イメージはコントロールのクライアント領域の下端に接して表示されます。このメンバーは、ulFlagsLVBKIF_STYLE_NORMAL が指定されている場合にのみ有効です。ulFlagsLVBKIF_FLAG_TILEOFFSETLVBKIF_STYLE_TILE の両方が指定されている場合、この値は最初のタイルのオフセットを、パーセンテージではなくピクセル単位で指定します。それ以外の場合、この値は無視されます。

公式ドキュメント

リストビューコントロールの背景イメージに関する情報を格納します。この構造体は、背景イメージ情報の設定と取得の両方に使用されます。

解説(Remarks)

この構造体は、LVM_GETBKIMAGE メッセージおよび LVM_SETBKIMAGE メッセージで使用されます。

メモ

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

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

各言語での定義

#include <windows.h>

// LVBKIMAGEA  (x64 40 / x86 24 バイト)
typedef struct LVBKIMAGEA {
    LIST_VIEW_BACKGROUND_IMAGE_FLAGS ulFlags;
    HBITMAP hbm;
    LPSTR pszImage;
    DWORD cchImageMax;
    INT xOffsetPercent;
    INT yOffsetPercent;
} LVBKIMAGEA;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct LVBKIMAGEA
{
    public uint ulFlags;
    public IntPtr hbm;
    public IntPtr pszImage;
    public uint cchImageMax;
    public int xOffsetPercent;
    public int yOffsetPercent;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure LVBKIMAGEA
    Public ulFlags As UInteger
    Public hbm As IntPtr
    Public pszImage As IntPtr
    Public cchImageMax As UInteger
    Public xOffsetPercent As Integer
    Public yOffsetPercent As Integer
End Structure
import ctypes
from ctypes import wintypes

class LVBKIMAGEA(ctypes.Structure):
    _fields_ = [
        ("ulFlags", wintypes.DWORD),
        ("hbm", ctypes.c_void_p),
        ("pszImage", ctypes.c_void_p),
        ("cchImageMax", wintypes.DWORD),
        ("xOffsetPercent", ctypes.c_int),
        ("yOffsetPercent", ctypes.c_int),
    ]
#[repr(C)]
pub struct LVBKIMAGEA {
    pub ulFlags: u32,
    pub hbm: *mut core::ffi::c_void,
    pub pszImage: *mut core::ffi::c_void,
    pub cchImageMax: u32,
    pub xOffsetPercent: i32,
    pub yOffsetPercent: i32,
}
import "golang.org/x/sys/windows"

type LVBKIMAGEA struct {
	ulFlags uint32
	hbm uintptr
	pszImage uintptr
	cchImageMax uint32
	xOffsetPercent int32
	yOffsetPercent int32
}
type
  LVBKIMAGEA = record
    ulFlags: DWORD;
    hbm: Pointer;
    pszImage: Pointer;
    cchImageMax: DWORD;
    xOffsetPercent: Integer;
    yOffsetPercent: Integer;
  end;
const LVBKIMAGEA = extern struct {
    ulFlags: u32,
    hbm: ?*anyopaque,
    pszImage: ?*anyopaque,
    cchImageMax: u32,
    xOffsetPercent: i32,
    yOffsetPercent: i32,
};
type
  LVBKIMAGEA {.bycopy.} = object
    ulFlags: uint32
    hbm: pointer
    pszImage: pointer
    cchImageMax: uint32
    xOffsetPercent: int32
    yOffsetPercent: int32
struct LVBKIMAGEA
{
    uint ulFlags;
    void* hbm;
    void* pszImage;
    uint cchImageMax;
    int xOffsetPercent;
    int yOffsetPercent;
}

HSP用 定義

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

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

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