Win32 API 日本語リファレンス
ホーム › UI.Input.Ime › CANDIDATELIST

CANDIDATELIST

構造体
📘 Microsoft Learn (日本語) · English
サイズx64: 28 バイト / x86: 28 バイト

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

フィールド

フィールド型サイズx64x86説明
dwSizeDWORD4+0+0この構造体、オフセット配列、およびすべての候補文字列のサイズ (バイト単位)。
dwStyleDWORD4+4+4

候補のスタイル値。このメンバーには、次の値のうち 1 つ以上を指定できます。

値 意味
IME_CAND_UNKNOWN 候補は、ここに記載されている以外のスタイルです。
IME_CAND_READ 候補は同じ読みです。
IME_CAND_CODE 候補はコード範囲内にあります。
IME_CAND_MEANING 候補は同じ意味です。
IME_CAND_RADICAL 候補は同じ部首の文字を使用します。
IME_CAND_STROKES 候補は同じ画数です。

IME_CAND_CODE スタイルの場合、候補リストは dwCount メンバーの値に応じて特別な構造になります。dwCount が 1 の場合、dwOffset メンバーはオフセットではなく単一の DBCS 文字を格納し、候補文字列は提供されません。dwCount メンバーが 1 より大きい場合、dwOffset メンバーは有効なオフセットを格納し、候補文字列は個々の DBCS 文字値を 16 進表記でテキスト表現したものになります。

dwCountDWORD4+8+8候補文字列の数。
dwSelectionDWORD4+12+12選択されている候補文字列のインデックス。
dwPageStartDWORD4+16+16候補ウィンドウ内の最初の候補文字列のインデックス。これは、ユーザーが PAGE UP キーおよび PAGE DOWN キーを押すことによって変化します。
dwPageSizeDWORD4+20+20候補ウィンドウの 1 ページに表示される候補文字列の数。ユーザーは、PAGE UP キーや PAGE DOWN キーなど、IME で定義されたキーを押すことによって次のページへ移動できます。この数値が 0 の場合、アプリケーションが独自に適切な値を定義できます。
dwOffsetDWORD4+24+24この構造体の先頭を基準とした、最初の候補文字列の先頭までのオフセット。後続の文字列のオフセットはこのメンバーの直後に続き、32 ビットのオフセットの配列を形成します。

公式ドキュメント

候補リストに関する情報を格納します。

解説(Remarks)

候補文字列は、dwOffset 配列の最後のオフセットの直後に続きます。

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

各言語での定義

#include <windows.h>

// CANDIDATELIST  (x64 28 / x86 28 バイト)
typedef struct CANDIDATELIST {
    DWORD dwSize;
    DWORD dwStyle;
    DWORD dwCount;
    DWORD dwSelection;
    DWORD dwPageStart;
    DWORD dwPageSize;
    DWORD dwOffset[1];
} CANDIDATELIST;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct CANDIDATELIST
{
    public uint dwSize;
    public uint dwStyle;
    public uint dwCount;
    public uint dwSelection;
    public uint dwPageStart;
    public uint dwPageSize;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst = 1)] public uint[] dwOffset;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure CANDIDATELIST
    Public dwSize As UInteger
    Public dwStyle As UInteger
    Public dwCount As UInteger
    Public dwSelection As UInteger
    Public dwPageStart As UInteger
    Public dwPageSize As UInteger
    <MarshalAs(UnmanagedType.ByValArray, SizeConst:=1)> Public dwOffset() As UInteger
End Structure
import ctypes
from ctypes import wintypes

class CANDIDATELIST(ctypes.Structure):
    _fields_ = [
        ("dwSize", wintypes.DWORD),
        ("dwStyle", wintypes.DWORD),
        ("dwCount", wintypes.DWORD),
        ("dwSelection", wintypes.DWORD),
        ("dwPageStart", wintypes.DWORD),
        ("dwPageSize", wintypes.DWORD),
        ("dwOffset", wintypes.DWORD * 1),
    ]
#[repr(C)]
pub struct CANDIDATELIST {
    pub dwSize: u32,
    pub dwStyle: u32,
    pub dwCount: u32,
    pub dwSelection: u32,
    pub dwPageStart: u32,
    pub dwPageSize: u32,
    pub dwOffset: [u32; 1],
}
import "golang.org/x/sys/windows"

type CANDIDATELIST struct {
	dwSize uint32
	dwStyle uint32
	dwCount uint32
	dwSelection uint32
	dwPageStart uint32
	dwPageSize uint32
	dwOffset [1]uint32
}
type
  CANDIDATELIST = record
    dwSize: DWORD;
    dwStyle: DWORD;
    dwCount: DWORD;
    dwSelection: DWORD;
    dwPageStart: DWORD;
    dwPageSize: DWORD;
    dwOffset: array[0..0] of DWORD;
  end;
const CANDIDATELIST = extern struct {
    dwSize: u32,
    dwStyle: u32,
    dwCount: u32,
    dwSelection: u32,
    dwPageStart: u32,
    dwPageSize: u32,
    dwOffset: [1]u32,
};
type
  CANDIDATELIST {.bycopy.} = object
    dwSize: uint32
    dwStyle: uint32
    dwCount: uint32
    dwSelection: uint32
    dwPageStart: uint32
    dwPageSize: uint32
    dwOffset: array[1, uint32]
struct CANDIDATELIST
{
    uint dwSize;
    uint dwStyle;
    uint dwCount;
    uint dwSelection;
    uint dwPageStart;
    uint dwPageSize;
    uint[1] dwOffset;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; CANDIDATELIST サイズ: 28 バイト(x64)
dim st, 7    ; 4byte整数×7(構造体サイズ 28 / 4 切り上げ)
; dwSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwStyle : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; dwCount : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; dwSelection : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; dwPageStart : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; dwPageSize : DWORD (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; dwOffset : DWORD (+24, 4byte)  varptr(st)+24 を基点に操作(4byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global CANDIDATELIST
    #field int dwSize
    #field int dwStyle
    #field int dwCount
    #field int dwSelection
    #field int dwPageStart
    #field int dwPageSize
    #field int dwOffset 1
#endstruct

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