GetCPInfoExA

関数

指定コードページの拡張情報を取得する。ANSI版。

DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL GetCPInfoExA(
    DWORD CodePage,
    DWORD dwFlags,
    CPINFOEXA* lpCPInfoEx
);

パラメーター

名前

型

方向

説明

CodePage

DWORD

情報を取得する対象のコードページの識別子。アプリケーションは、インストール済みまたは利用可能な任意のコードページの識別子、または次の定義済みの値のいずれかを指定できます。ANSI およびその他のコードページの識別子の一覧については、Code Page Identifiers を参照してください。

値	意味
CP_ACP	システム既定の Windows ANSI コードページを使用します。
CP_MACCP	システム既定の Macintosh コードページを使用します。
CP_OEMCP	システム既定の OEM コードページを使用します。
CP_THREAD_ACP	現在のスレッドの ANSI コードページを使用します。

dwFlags

DWORD

予約済み。0 を指定する必要があります。

lpCPInfoEx

CPINFOEXA*

out

コードページに関する情報を受け取る CPINFOEX 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

インストール済みまたは利用可能な任意の有効なコードページに関する情報を取得します。(GetCPInfoExA)

戻り値

成功した場合は 0 以外の値を返し、それ以外の場合は 0 を返します。拡張エラー情報を取得するには、アプリケーションは GetLastError を呼び出すことができ、次のいずれかのエラーコードが返されることがあります。

いずれかのパラメーター値が無効な場合は ERROR_INVALID_PARAMETER。
コードページ 1147 の場合は ERROR_SUCCESS。
コードページ 20949 の場合は ERROR_MUI_FILE_NOT_FOUND。

解説(Remarks)

CPINFOEX 構造体で取得される情報は、すべてのコードページにとって必ずしも有用であるとは限りません。たとえばバッファーサイズを判断するには、アプリケーションは MultiByteToWideChar または WideCharToMultiByte を呼び出して、正確なバッファーサイズを要求する必要があります。CPINFOEX の設定が先頭バイトの存在を示している場合でも、変換関数が必ずしも先頭バイトを特別に扱うとは限りません。たとえば、後続バイトが欠落していたり不正であったりする場合などです。

メモ

winnls.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GetCPInfoEx を定義します。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、不整合が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL GetCPInfoExA(
    DWORD CodePage,
    DWORD dwFlags,
    CPINFOEXA* lpCPInfoEx
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool GetCPInfoExA(
    uint CodePage,   // DWORD
    uint dwFlags,   // DWORD
    IntPtr lpCPInfoEx   // CPINFOEXA* out
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetCPInfoExA(
    CodePage As UInteger,   ' DWORD
    dwFlags As UInteger,   ' DWORD
    lpCPInfoEx As IntPtr   ' CPINFOEXA* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' CodePage : DWORD
' dwFlags : DWORD
' lpCPInfoEx : CPINFOEXA* out
Declare PtrSafe Function GetCPInfoExA Lib "kernel32" ( _
    ByVal CodePage As Long, _
    ByVal dwFlags As Long, _
    ByVal lpCPInfoEx As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetCPInfoExA = ctypes.windll.kernel32.GetCPInfoExA
GetCPInfoExA.restype = wintypes.BOOL
GetCPInfoExA.argtypes = [
    wintypes.DWORD,  # CodePage : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # lpCPInfoEx : CPINFOEXA* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetCPInfoExA = Fiddle::Function.new(
  lib['GetCPInfoExA'],
  [
    -Fiddle::TYPE_INT,  # CodePage : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpCPInfoEx : CPINFOEXA* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetCPInfoExA(
        CodePage: u32,  // DWORD
        dwFlags: u32,  // DWORD
        lpCPInfoEx: *mut CPINFOEXA  // CPINFOEXA* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool GetCPInfoExA(uint CodePage, uint dwFlags, IntPtr lpCPInfoEx);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetCPInfoExA' -Namespace Win32 -PassThru
# $api::GetCPInfoExA(CodePage, dwFlags, lpCPInfoEx)

#uselib "KERNEL32.dll"
#func global GetCPInfoExA "GetCPInfoExA" sptr, sptr, sptr
; GetCPInfoExA CodePage, dwFlags, varptr(lpCPInfoEx)   ; 戻り値は stat
; CodePage : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; lpCPInfoEx : CPINFOEXA* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetCPInfoExA "GetCPInfoExA" int, int, var
; res = GetCPInfoExA(CodePage, dwFlags, lpCPInfoEx)
; CodePage : DWORD -> "int"
; dwFlags : DWORD -> "int"
; lpCPInfoEx : CPINFOEXA* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetCPInfoExA "GetCPInfoExA" int, int, sptr
; res = GetCPInfoExA(CodePage, dwFlags, varptr(lpCPInfoEx))
; CodePage : DWORD -> "int"
; dwFlags : DWORD -> "int"
; lpCPInfoEx : CPINFOEXA* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。