LCMapStringW

関数

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

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

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

INT LCMapStringW(
    DWORD Locale,
    DWORD dwMapFlags,
    LPCWSTR lpSrcStr,
    INT cchSrc,
    LPWSTR 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	LPCWSTR	in	関数がマッピングするか、ソートキー生成に使用するソース文字列へのポインターです。この文字列のサイズを 0 にすることはできません。
cchSrc	INT	in	lpSrcStr で示されるソース文字列のサイズ(文字数)です。ソース文字列のサイズには終端の null 文字を含めることができますが、含める必要はありません。終端の null 文字が含まれている場合でも、終端の null 文字はソート不可能とみなされ常に自分自身にマッピングされるため、関数のマッピング動作に大きな影響はありません。アプリケーションはこのパラメーターに任意の負の値を設定することで、ソース文字列が null 終端であることを指定できます。この場合、LCMapString が文字列マッピングモードで使用されているときは、関数が文字列の長さを自身で計算し、lpDestStr で示されるマッピング後の文字列を null 終端にします。アプリケーションはこのパラメーターに 0 を設定することはできません。
lpDestStr	LPWSTR	outoptional	この関数がマッピング後の文字列またはソートキーを取得するバッファーへのポインターです。アプリケーションがソートキー(LCMAP_SORTKEY)を生成するために関数を使用している場合: ソートキーはバッファーに格納され、不透明なバイト配列として扱われます。格納される値には、任意の位置に埋め込まれた 0 バイトが含まれることがあります。デスティネーション文字列には奇数のバイト数を含めることができます。LCMAP_BYTEREV フラグは偶数のバイト数のみを反転します。ソートキーの最後のバイト(奇数位置)は反転されません。呼び出し元が文字列のサブセットを明示的に要求した場合、呼び出し元が cchDest で指定しない限り、デスティネーション文字列には終端の null 文字は含まれません。この関数が失敗した場合、デスティネーションバッファーには部分的な結果が含まれることもあれば、まったく結果が含まれないこともあります。この場合、すべての結果は無効とみなすべきです。メモ LCMAP_UPPERCASE または LCMAP_LOWERCASE を設定する場合、デスティネーション文字列はソース文字列と同じバッファーを使用できます。ただし、一部の条件では返される大文字小文字変換後の文字列の長さが異なる場合があるため、これは強く推奨されません。
cchDest	INT	in	lpDestStr で示されるデスティネーション文字列のサイズ(文字数)です。アプリケーションが文字列マッピングのために関数を使用している場合、このパラメーターには文字数を指定します。終端の null 文字のための領域が cchSrc に含まれている場合、cchDest にも終端の null 文字のための領域を含める必要があります。アプリケーションがソートキーを生成するために関数を使用している場合、サイズにはバイト数を指定します。このバイト数には、ソートキーの 0x00 終端子のための領域を含める必要があります。アプリケーションは cchDest に 0 を設定できます。この場合、関数は lpDestStr パラメーターを使用せず、マッピング後の文字列またはソートキーに必要なバッファーサイズを返します。

戻り値の型: INT

公式ドキュメント

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

戻り値

関数が文字列マッピングに使用されて成功した場合、変換後の文字列の文字数を返します(詳細は 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 ヘッダーは LCMapString を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI バージョンまたは Unicode バージョンを自動的に選択するエイリアスとして定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーまたは実行時エラーを引き起こす不一致につながる可能性があります。詳細については、関数プロトタイプの規約を参照してください。

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

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

INT LCMapStringW(
    DWORD Locale,
    DWORD dwMapFlags,
    LPCWSTR lpSrcStr,
    INT cchSrc,
    LPWSTR lpDestStr,   // optional
    INT cchDest
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern int LCMapStringW(
    uint Locale,   // DWORD
    uint dwMapFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string lpSrcStr,   // LPCWSTR
    int cchSrc,   // INT
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpDestStr,   // LPWSTR optional, out
    int cchDest   // INT
);

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

' Locale : DWORD
' dwMapFlags : DWORD
' lpSrcStr : LPCWSTR
' cchSrc : INT
' lpDestStr : LPWSTR optional, out
' cchDest : INT
Declare PtrSafe Function LCMapStringW Lib "kernel32" ( _
    ByVal Locale As Long, _
    ByVal dwMapFlags As Long, _
    ByVal lpSrcStr As LongPtr, _
    ByVal cchSrc As Long, _
    ByVal lpDestStr As LongPtr, _
    ByVal cchDest As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

LCMapStringW = ctypes.windll.kernel32.LCMapStringW
LCMapStringW.restype = ctypes.c_int
LCMapStringW.argtypes = [
    wintypes.DWORD,  # Locale : DWORD
    wintypes.DWORD,  # dwMapFlags : DWORD
    wintypes.LPCWSTR,  # lpSrcStr : LPCWSTR
    ctypes.c_int,  # cchSrc : INT
    wintypes.LPWSTR,  # lpDestStr : LPWSTR 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')
LCMapStringW = Fiddle::Function.new(
  lib['LCMapStringW'],
  [
    -Fiddle::TYPE_INT,  # Locale : DWORD
    -Fiddle::TYPE_INT,  # dwMapFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpSrcStr : LPCWSTR
    Fiddle::TYPE_INT,  # cchSrc : INT
    Fiddle::TYPE_VOIDP,  # lpDestStr : LPWSTR optional, out
    Fiddle::TYPE_INT,  # cchDest : INT
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

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

出力引数:

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