LCMapStringA

関数

ANSI文字列にロケール依存のマッピング変換を行う。

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

シグネチャ

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

INT LCMapStringA(
    DWORD Locale,
    DWORD dwMapFlags,
    LPCSTR lpSrcStr,
    INT cchSrc,
    LPSTR lpDestStr,   // optional
    INT cchDest
);

パラメーター

名前	型	方向	説明
Locale	DWORD	in	ロケールを指定するロケール識別子。MAKELCID マクロを使用してロケール識別子を作成するか、次の定義済みの値のいずれかを使用できます。 LOCALE_INVARIANT LOCALE_SYSTEM_DEFAULT LOCALE_USER_DEFAULT 次のカスタムロケール識別子もサポートされています。 LOCALE_CUSTOM_DEFAULT LOCALE_CUSTOM_UI_DEFAULT LOCALE_CUSTOM_UNSPECIFIED
dwMapFlags	DWORD	in	文字列マッピング時に使用する変換の種類、または生成するソートキーの種類を指定するフラグ。詳細な定義については、LCMapStringEx の dwMapFlags パラメーターを参照してください。
lpSrcStr	LPCSTR	in	この関数がマップする、またはソートキー生成に使用するソース文字列へのポインター。この文字列のサイズを 0 にすることはできません。
cchSrc	INT	in	lpSrcStr で示されるソース文字列のサイズ(文字数)。ソース文字列のサイズには終端の null 文字を含めることができますが、必須ではありません。終端の null 文字が含まれていても、この関数のマッピング動作に大きな影響はありません。終端の null 文字はソート不可とみなされ、常にそれ自身にマップされるためです。アプリケーションは、このパラメーターに任意の負の値を設定して、ソース文字列が null で終端されていることを指定できます。この場合、LCMapString が文字列マッピングモードで使用されているときは、関数自身が文字列の長さを計算し、lpDestStr で示されるマップ後の文字列を null で終端します。このパラメーターに 0 を設定することはできません。
lpDestStr	LPSTR	outoptional	この関数がマップ後の文字列またはソートキーを取得するバッファーへのポインター。アプリケーションがこの関数を使用してソートキー(LCMAP_SORTKEY)を生成する場合: ソートキーはバッファーに格納され、不透明なバイト配列として扱われます。格納される値には、任意の位置に埋め込まれた 0 バイトが含まれることがあります。出力先の文字列には奇数バイトが含まれることがあります。LCMAP_BYTEREV フラグは偶数バイトのみを反転します。ソートキーの最後のバイト(奇数位置)は反転されません。呼び出し元が文字列のサブセットを明示的に要求した場合、呼び出し元が cchDest で指定しない限り、出力先の文字列には終端の null 文字は含まれません。この関数が失敗した場合、出力先バッファーには部分的な結果が含まれるか、まったく結果が含まれないことがあります。この場合、すべての結果は無効とみなす必要があります。メモ LCMAP_UPPERCASE または LCMAP_LOWERCASE を設定する場合、出力先の文字列にソース文字列と同じバッファーを使用できます。ただし、条件によっては返される大文字小文字変換後の文字列の長さが異なる場合があるため、これは強く推奨されません。
cchDest	INT	in	lpDestStr で示される出力先の文字列のサイズ(文字数)。アプリケーションがこの関数を文字列マッピングに使用する場合は、このパラメーターに文字数を指定します。cchSrc に終端の null 文字分のスペースが含まれている場合、cchDest にも終端の null 文字分のスペースを含める必要があります。アプリケーションがこの関数をソートキーの生成に使用する場合は、サイズとしてバイト数を指定します。このバイト数には、ソートキーの 0x00 終端子分のスペースを含める必要があります。アプリケーションは cchDest に 0 を設定できます。この場合、関数は lpDestStr パラメーターを使用せず、マップ後の文字列またはソートキーに必要なバッファーサイズを返します。

戻り値の型: INT

公式ドキュメント

識別子で指定したロケールについて、指定した変換を使用して入力文字列を別の文字列にマップするか、入力文字列のソートキーを生成します。(ANSI)

戻り値

文字列マッピングに使用された関数が成功した場合、変換後の文字列の文字数を返します(詳細は cchSrc および cchDest を参照してください)。

文字列マッピングに使用された関数が成功した場合、ソートキーのバイト数を返します。

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

ERROR_INSUFFICIENT_BUFFER。指定されたバッファーサイズが十分な大きさでなかったか、誤って NULL に設定されていました。
ERROR_INVALID_FLAGS。フラグに指定された値が無効でした。
ERROR_INVALID_PARAMETER。いずれかのパラメーター値が無効でした。

ERROR_INSUFFICIENT_BUFFER。指定されたバッファーサイズが十分な大きさでなかったか、誤って NULL に設定されていました。
ERROR_INVALID_FLAGS。フラグに指定された値が無効でした。
ERROR_INVALID_PARAMETER。いずれかのパラメーター値が無効でした。

解説(Remarks)

備考については LCMapStringEx を参照してください。

LCMapString の ANSI 版は、指定したロケールに関連付けられた既定の Windows (ANSI) コードページに基づいて、文字列を Unicode との間で相互にマップします。この関数の ANSI 版を Unicode 専用のロケールで使用した場合、オペレーティングシステムがシステム既定の Windows ANSI コードページを表す CP_ACP 値を使用するため、関数は成功することがあります。ただし、システムコードページで未定義の文字は、文字列内で疑問符 (?) として表示されます。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

INT LCMapStringA(
    DWORD Locale,
    DWORD dwMapFlags,
    LPCSTR lpSrcStr,
    INT cchSrc,
    LPSTR lpDestStr,   // optional
    INT cchDest
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern int LCMapStringA(
    uint Locale,   // DWORD
    uint dwMapFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string lpSrcStr,   // LPCSTR
    int cchSrc,   // INT
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpDestStr,   // LPSTR optional, out
    int cchDest   // INT
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function LCMapStringA(
    Locale As UInteger,   ' DWORD
    dwMapFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpSrcStr As String,   ' LPCSTR
    cchSrc As Integer,   ' INT
    <MarshalAs(UnmanagedType.LPStr)> lpDestStr As System.Text.StringBuilder,   ' LPSTR optional, out
    cchDest As Integer   ' INT
) As Integer
End Function

' Locale : DWORD
' dwMapFlags : DWORD
' lpSrcStr : LPCSTR
' cchSrc : INT
' lpDestStr : LPSTR optional, out
' cchDest : INT
Declare PtrSafe Function LCMapStringA Lib "kernel32" ( _
    ByVal Locale As Long, _
    ByVal dwMapFlags As Long, _
    ByVal lpSrcStr As String, _
    ByVal cchSrc As Long, _
    ByVal lpDestStr As String, _
    ByVal cchDest As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

LCMapStringA = ctypes.windll.kernel32.LCMapStringA
LCMapStringA.restype = ctypes.c_int
LCMapStringA.argtypes = [
    wintypes.DWORD,  # Locale : DWORD
    wintypes.DWORD,  # dwMapFlags : DWORD
    wintypes.LPCSTR,  # lpSrcStr : LPCSTR
    ctypes.c_int,  # cchSrc : INT
    wintypes.LPSTR,  # lpDestStr : LPSTR optional, out
    ctypes.c_int,  # cchDest : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
LCMapStringA = Fiddle::Function.new(
  lib['LCMapStringA'],
  [
    -Fiddle::TYPE_INT,  # Locale : DWORD
    -Fiddle::TYPE_INT,  # dwMapFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpSrcStr : LPCSTR
    Fiddle::TYPE_INT,  # cchSrc : INT
    Fiddle::TYPE_VOIDP,  # lpDestStr : LPSTR optional, out
    Fiddle::TYPE_INT,  # cchDest : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn LCMapStringA(
        Locale: u32,  // DWORD
        dwMapFlags: u32,  // DWORD
        lpSrcStr: *const u8,  // LPCSTR
        cchSrc: i32,  // INT
        lpDestStr: *mut u8,  // LPSTR optional, out
        cchDest: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern int LCMapStringA(uint Locale, uint dwMapFlags, [MarshalAs(UnmanagedType.LPStr)] string lpSrcStr, int cchSrc, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpDestStr, int cchDest);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_LCMapStringA' -Namespace Win32 -PassThru
# $api::LCMapStringA(Locale, dwMapFlags, lpSrcStr, cchSrc, lpDestStr, cchDest)

#uselib "KERNEL32.dll"
#func global LCMapStringA "LCMapStringA" sptr, sptr, sptr, sptr, sptr, sptr
; LCMapStringA Locale, dwMapFlags, lpSrcStr, cchSrc, varptr(lpDestStr), cchDest   ; 戻り値は stat
; Locale : DWORD -> "sptr"
; dwMapFlags : DWORD -> "sptr"
; lpSrcStr : LPCSTR -> "sptr"
; cchSrc : INT -> "sptr"
; lpDestStr : LPSTR optional, out -> "sptr"
; cchDest : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global LCMapStringA "LCMapStringA" int, int, str, int, var, int
; res = LCMapStringA(Locale, dwMapFlags, lpSrcStr, cchSrc, lpDestStr, cchDest)
; Locale : DWORD -> "int"
; dwMapFlags : DWORD -> "int"
; lpSrcStr : LPCSTR -> "str"
; cchSrc : INT -> "int"
; lpDestStr : LPSTR optional, out -> "var"
; cchDest : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global LCMapStringA "LCMapStringA" int, int, str, int, sptr, int
; res = LCMapStringA(Locale, dwMapFlags, lpSrcStr, cchSrc, varptr(lpDestStr), cchDest)
; Locale : DWORD -> "int"
; dwMapFlags : DWORD -> "int"
; lpSrcStr : LPCSTR -> "str"
; cchSrc : INT -> "int"
; lpDestStr : LPSTR optional, out -> "sptr"
; cchDest : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。