LCMapStringEx

関数

ロケール名を指定して文字列を変換またはソートキー生成する。

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

シグネチャ

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

INT LCMapStringEx(
    LPCWSTR lpLocaleName,   // optional
    DWORD dwMapFlags,
    LPCWSTR lpSrcStr,
    INT cchSrc,
    LPWSTR lpDestStr,   // optional
    INT cchDest,
    NLSVERSIONINFO* lpVersionInformation,   // optional
    void* lpReserved,   // optional
    LPARAM sortHandle
);

パラメーター

名前	型	方向
lpLocaleName	LPCWSTR	inoptional
dwMapFlags	DWORD	in
lpSrcStr	LPCWSTR	in
cchSrc	INT	in
lpDestStr	LPWSTR	outoptional
cchDest	INT	in
lpVersionInformation	NLSVERSIONINFO*	inoptional
lpReserved	void*	inoptional
sortHandle	LPARAM	in

戻り値の型: INT

各言語での呼び出し定義

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

INT LCMapStringEx(
    LPCWSTR lpLocaleName,   // optional
    DWORD dwMapFlags,
    LPCWSTR lpSrcStr,
    INT cchSrc,
    LPWSTR lpDestStr,   // optional
    INT cchDest,
    NLSVERSIONINFO* lpVersionInformation,   // optional
    void* lpReserved,   // optional
    LPARAM sortHandle
);

[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern int LCMapStringEx(
    [MarshalAs(UnmanagedType.LPWStr)] string lpLocaleName,   // LPCWSTR optional
    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
    IntPtr lpVersionInformation,   // NLSVERSIONINFO* optional
    IntPtr lpReserved,   // void* optional
    IntPtr sortHandle   // LPARAM
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function LCMapStringEx(
    <MarshalAs(UnmanagedType.LPWStr)> lpLocaleName As String,   ' LPCWSTR optional
    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
    lpVersionInformation As IntPtr,   ' NLSVERSIONINFO* optional
    lpReserved As IntPtr,   ' void* optional
    sortHandle As IntPtr   ' LPARAM
) As Integer
End Function

' lpLocaleName : LPCWSTR optional
' dwMapFlags : DWORD
' lpSrcStr : LPCWSTR
' cchSrc : INT
' lpDestStr : LPWSTR optional, out
' cchDest : INT
' lpVersionInformation : NLSVERSIONINFO* optional
' lpReserved : void* optional
' sortHandle : LPARAM
Declare PtrSafe Function LCMapStringEx Lib "kernel32" ( _
    ByVal lpLocaleName As LongPtr, _
    ByVal dwMapFlags As Long, _
    ByVal lpSrcStr As LongPtr, _
    ByVal cchSrc As Long, _
    ByVal lpDestStr As LongPtr, _
    ByVal cchDest As Long, _
    ByVal lpVersionInformation As LongPtr, _
    ByVal lpReserved As LongPtr, _
    ByVal sortHandle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

LCMapStringEx = ctypes.windll.kernel32.LCMapStringEx
LCMapStringEx.restype = ctypes.c_int
LCMapStringEx.argtypes = [
    wintypes.LPCWSTR,  # lpLocaleName : LPCWSTR optional
    wintypes.DWORD,  # dwMapFlags : DWORD
    wintypes.LPCWSTR,  # lpSrcStr : LPCWSTR
    ctypes.c_int,  # cchSrc : INT
    wintypes.LPWSTR,  # lpDestStr : LPWSTR optional, out
    ctypes.c_int,  # cchDest : INT
    ctypes.c_void_p,  # lpVersionInformation : NLSVERSIONINFO* optional
    ctypes.POINTER(None),  # lpReserved : void* optional
    ctypes.c_ssize_t,  # sortHandle : LPARAM
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
LCMapStringEx = Fiddle::Function.new(
  lib['LCMapStringEx'],
  [
    Fiddle::TYPE_VOIDP,  # lpLocaleName : LPCWSTR optional
    -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_VOIDP,  # lpVersionInformation : NLSVERSIONINFO* optional
    Fiddle::TYPE_VOIDP,  # lpReserved : void* optional
    Fiddle::TYPE_INTPTR_T,  # sortHandle : LPARAM
  ],
  Fiddle::TYPE_INT)

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

$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern int LCMapStringEx([MarshalAs(UnmanagedType.LPWStr)] string lpLocaleName, uint dwMapFlags, [MarshalAs(UnmanagedType.LPWStr)] string lpSrcStr, int cchSrc, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpDestStr, int cchDest, IntPtr lpVersionInformation, IntPtr lpReserved, IntPtr sortHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_LCMapStringEx' -Namespace Win32 -PassThru
# $api::LCMapStringEx(lpLocaleName, dwMapFlags, lpSrcStr, cchSrc, lpDestStr, cchDest, lpVersionInformation, lpReserved, sortHandle)

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

出力引数:

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

出力引数:

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

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procLCMapStringEx = kernel32.NewProc("LCMapStringEx")
)

// lpLocaleName (LPCWSTR optional), dwMapFlags (DWORD), lpSrcStr (LPCWSTR), cchSrc (INT), lpDestStr (LPWSTR optional, out), cchDest (INT), lpVersionInformation (NLSVERSIONINFO* optional), lpReserved (void* optional), sortHandle (LPARAM)
r1, _, err := procLCMapStringEx.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpLocaleName))),
	uintptr(dwMapFlags),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpSrcStr))),
	uintptr(cchSrc),
	uintptr(lpDestStr),
	uintptr(cchDest),
	uintptr(lpVersionInformation),
	uintptr(lpReserved),
	uintptr(sortHandle),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT

function LCMapStringEx(
  lpLocaleName: PWideChar;   // LPCWSTR optional
  dwMapFlags: DWORD;   // DWORD
  lpSrcStr: PWideChar;   // LPCWSTR
  cchSrc: Integer;   // INT
  lpDestStr: PWideChar;   // LPWSTR optional, out
  cchDest: Integer;   // INT
  lpVersionInformation: Pointer;   // NLSVERSIONINFO* optional
  lpReserved: Pointer;   // void* optional
  sortHandle: NativeInt   // LPARAM
): Integer; stdcall;
  external 'KERNEL32.dll' name 'LCMapStringEx';

result := DllCall("KERNEL32\LCMapStringEx"
    , "WStr", lpLocaleName   ; LPCWSTR optional
    , "UInt", dwMapFlags   ; DWORD
    , "WStr", lpSrcStr   ; LPCWSTR
    , "Int", cchSrc   ; INT
    , "Ptr", lpDestStr   ; LPWSTR optional, out
    , "Int", cchDest   ; INT
    , "Ptr", lpVersionInformation   ; NLSVERSIONINFO* optional
    , "Ptr", lpReserved   ; void* optional
    , "Ptr", sortHandle   ; LPARAM
    , "Int")   ; return: INT

●LCMapStringEx(lpLocaleName, dwMapFlags, lpSrcStr, cchSrc, lpDestStr, cchDest, lpVersionInformation, lpReserved, sortHandle) = DLL("KERNEL32.dll", "int LCMapStringEx(char*, dword, char*, int, char*, int, void*, void*, int)")
# 呼び出し: LCMapStringEx(lpLocaleName, dwMapFlags, lpSrcStr, cchSrc, lpDestStr, cchDest, lpVersionInformation, lpReserved, sortHandle)
# lpLocaleName : LPCWSTR optional -> "char*"
# dwMapFlags : DWORD -> "dword"
# lpSrcStr : LPCWSTR -> "char*"
# cchSrc : INT -> "int"
# lpDestStr : LPWSTR optional, out -> "char*"
# cchDest : INT -> "int"
# lpVersionInformation : NLSVERSIONINFO* optional -> "void*"
# lpReserved : void* optional -> "void*"
# sortHandle : LPARAM -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。