GetCPInfo

関数

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

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL GetCPInfo(
    DWORD CodePage,
    CPINFO* lpCPInfo
);

パラメーター

名前	型	方向	説明
CodePage	DWORD	in	情報を取得するコードページの識別子です。詳細については、GetCPInfoEx の CodePage パラメーターを参照してください。
lpCPInfo	CPINFO*	out	コードページに関する情報を受け取る CPINFO 構造体へのポインターです。「解説」セクションを参照してください。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

ERROR_INVALID_PARAMETER。いずれかのパラメーター値が無効でした。

解説(Remarks)

GetCPInfoEx の「解説」を参照してください。

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

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL GetCPInfo(
    DWORD CodePage,
    CPINFO* lpCPInfo
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetCPInfo(
    uint CodePage,   // DWORD
    IntPtr lpCPInfo   // CPINFO* out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetCPInfo(
    CodePage As UInteger,   ' DWORD
    lpCPInfo As IntPtr   ' CPINFO* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

GetCPInfo = ctypes.windll.kernel32.GetCPInfo
GetCPInfo.restype = wintypes.BOOL
GetCPInfo.argtypes = [
    wintypes.DWORD,  # CodePage : DWORD
    ctypes.c_void_p,  # lpCPInfo : CPINFO* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetCPInfo = Fiddle::Function.new(
  lib['GetCPInfo'],
  [
    -Fiddle::TYPE_INT,  # CodePage : DWORD
    Fiddle::TYPE_VOIDP,  # lpCPInfo : CPINFO* out
  ],
  Fiddle::TYPE_INT)

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

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

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

出力引数:

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