CPINFOEXW

構造体

サイズx64: 544 バイト / x86: 544 バイト

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

フィールド

フィールド	型	サイズ	x64	x86	説明
MaxCharSize	DWORD	4	+0	+0	コードページ内の文字の最大長 (バイト単位)。この長さは、シングルバイト文字セット (SBCS) では 1、ダブルバイト文字セット (DBCS) では 2、それ以外の種類の文字セットでは 2 より大きい値になります。ISCII や ISO-2022-xx のコードページが使用されるなどの要因があるため、この関数はこのサイズによって SBCS や DBCS を他の文字セットと区別することはできません。
DefaultChar	BYTE	2	+4	+4	文字列を特定のコードページに変換する際に使用される既定の文字です。明示的な既定文字が指定されていない場合、この文字が WideCharToMultiByte 関数によって使用されます。既定値は通常、そのコードページの "?" 文字です。
LeadByte	BYTE	12	+6	+6	先行バイト範囲の固定長配列です。先行バイト範囲の数は可変です。コードページに先行バイトが無い場合、配列のすべての要素は NULL に設定されます。コードページに先行バイトがある場合、配列は各範囲の開始値と終了値を指定します。範囲は両端を含み、1 つのコードページあたりの範囲の最大数は 5 です。配列は各範囲を記述するために 2 バイトを使用し、最後の範囲の後には終端として 2 つのヌルバイトが置かれます。メモ一部のコードページは、先行バイトと他のエンコード方式を組み合わせて使用します。このメンバーは通常、何らかの形で先行バイトを使用するコードページの一部に対してのみ設定されます。詳細については、「解説」セクションを参照してください。
UnicodeDefaultChar	WCHAR	2	+18	+18	特定のコードページからの変換で使用される Unicode の既定文字です。既定値は通常、"?" 文字または片仮名中点文字です。Unicode の既定文字は MultiByteToWideChar 関数によって使用されます。
CodePage	DWORD	4	+20	+20	コードページの値です。この値は、GetCPInfoEx 関数に渡されたコードページを反映します。ANSI およびその他のコードページの一覧については、コードページ識別子を参照してください。
CodePageName	WCHAR	520	+24	+24	コードページの完全な名前です。この名前はローカライズされており、オペレーティングシステムのバージョン間やコンピューター間で一意性や一貫性が保証されるものではないことに注意してください。

公式ドキュメント

コードページに関する情報を格納します。この構造体は GetCPInfoEx 関数で使用されます。

解説(Remarks)

先行バイトは、256 文字を超える文字を扱える DBCS コードページに固有のものです。先行バイトは、DBCS における 2 バイト文字の最初のバイトです。各 DBCS コードページでは、先行バイトはバイト値の特定の範囲を占めます。この範囲はコードページごとに異なります。

先行バイトの情報はほとんどのコードページであまり役に立たず、UTF-8 や GB18030 などの多くのマルチバイトエンコードでは提供すらされません。MultiByteToWideChar 関数や WideCharToMultiByte 関数の動作を予測するためにこの情報を使用することは推奨されません。先行バイトに続くバイトが想定どおりでない場合、これらの関数は既定の文字を使用したり、その他の既定の動作を行ったりすることがあります。

メモ

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

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

各言語での定義

#include <windows.h>

// CPINFOEXW  (x64 544 / x86 544 バイト)
typedef struct CPINFOEXW {
    DWORD MaxCharSize;
    BYTE DefaultChar[2];
    BYTE LeadByte[12];
    WCHAR UnicodeDefaultChar;
    DWORD CodePage;
    WCHAR CodePageName[260];
} CPINFOEXW;

using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct CPINFOEXW
{
    public uint MaxCharSize;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst = 2)] public byte[] DefaultChar;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst = 12)] public byte[] LeadByte;
    public char UnicodeDefaultChar;
    public uint CodePage;
    [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 260)] public string CodePageName;
}

Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure CPINFOEXW
    Public MaxCharSize As UInteger
    <MarshalAs(UnmanagedType.ByValArray, SizeConst:=2)> Public DefaultChar() As Byte
    <MarshalAs(UnmanagedType.ByValArray, SizeConst:=12)> Public LeadByte() As Byte
    Public UnicodeDefaultChar As Char
    Public CodePage As UInteger
    <MarshalAs(UnmanagedType.ByValTStr, SizeConst:=260)> Public CodePageName As String
End Structure

import ctypes
from ctypes import wintypes

class CPINFOEXW(ctypes.Structure):
    _fields_ = [
        ("MaxCharSize", wintypes.DWORD),
        ("DefaultChar", ctypes.c_ubyte * 2),
        ("LeadByte", ctypes.c_ubyte * 12),
        ("UnicodeDefaultChar", ctypes.c_wchar),
        ("CodePage", wintypes.DWORD),
        ("CodePageName", ctypes.c_wchar * 260),
    ]

#[repr(C)]
pub struct CPINFOEXW {
    pub MaxCharSize: u32,
    pub DefaultChar: [u8; 2],
    pub LeadByte: [u8; 12],
    pub UnicodeDefaultChar: u16,
    pub CodePage: u32,
    pub CodePageName: [u16; 260],
}

import "golang.org/x/sys/windows"

type CPINFOEXW struct {
	MaxCharSize uint32
	DefaultChar [2]byte
	LeadByte [12]byte
	UnicodeDefaultChar uint16
	CodePage uint32
	CodePageName [260]uint16
}

type
  CPINFOEXW = record
    MaxCharSize: DWORD;
    DefaultChar: array[0..1] of Byte;
    LeadByte: array[0..11] of Byte;
    UnicodeDefaultChar: WideChar;
    CodePage: DWORD;
    CodePageName: array[0..259] of WideChar;
  end;

const CPINFOEXW = extern struct {
    MaxCharSize: u32,
    DefaultChar: [2]u8,
    LeadByte: [12]u8,
    UnicodeDefaultChar: u16,
    CodePage: u32,
    CodePageName: [260]u16,
};

type
  CPINFOEXW {.bycopy.} = object
    MaxCharSize: uint32
    DefaultChar: array[2, uint8]
    LeadByte: array[12, uint8]
    UnicodeDefaultChar: uint16
    CodePage: uint32
    CodePageName: array[260, uint16]

struct CPINFOEXW
{
    uint MaxCharSize;
    ubyte[2] DefaultChar;
    ubyte[12] LeadByte;
    wchar UnicodeDefaultChar;
    uint CodePage;
    wchar[260] CodePageName;
}

HSP用定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; CPINFOEXW サイズ: 544 バイト(x64)
dim st, 136    ; 4byte整数×136(構造体サイズ 544 / 4 切り上げ)
; MaxCharSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; DefaultChar : BYTE (+4, 2byte)  varptr(st)+4 を基点に操作(2byte:入れ子/配列)
; LeadByte : BYTE (+6, 12byte)  varptr(st)+6 を基点に操作(12byte:入れ子/配列)
; UnicodeDefaultChar : WCHAR (+18, 2byte)  wpoke st,18,値  /  値 = wpeek(st,18)
; CodePage : DWORD (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; CodePageName : WCHAR (+24, 520byte)  varptr(st)+24 を基点に操作(520byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。

; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global CPINFOEXW
    #field int MaxCharSize
    #field byte DefaultChar 2
    #field byte LeadByte 12
    #field short UnicodeDefaultChar
    #field int CodePage
    #field wchar CodePageName 260
#endstruct

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