LCMapStringEx
関数シグネチャ
// 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 | 文字列のマッピング時に使用する変換の種類、または生成するソートキーの種類を指定するフラグ。このパラメーターには次の値を指定できます。
次のフラグは、単独で、相互に組み合わせて、または LCMAP_SORTKEY や LCMAP_BYTEREV フラグと組み合わせて使用できます。ただし、上記の他のフラグと組み合わせることはできません。
以下に示すフラグは、LCMAP_SORTKEY フラグとのみ併用できます。
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| lpSrcStr | LPCWSTR | in | 関数がマッピングに使用する、またはソートキーの生成に使用するソース文字列へのポインター。この文字列のサイズを 0 にすることはできません。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| cchSrc | INT | in | lpSrcStr で示されるソース文字列のサイズ (文字数)。ソース文字列のサイズには終端の null 文字を含めることができますが、必須ではありません。終端の null 文字が含まれていても、終端の null 文字はソート不可能とみなされ常に自分自身にマップされるため、関数のマッピング動作に大きな影響はありません。 アプリケーションはこのパラメーターに任意の負の値を設定して、ソース文字列が null 終端であることを指定できます。この場合、LCMapStringEx が文字列マッピングモードで使用されているときは、関数自身が文字列の長さを計算し、lpDestStr で示されるマップ後の文字列を null 終端にします。 アプリケーションはこのパラメーターに 0 を設定できません。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| lpDestStr | LPWSTR | outoptional | この関数がマップ後の文字列またはソートキーを取得するバッファーへのポインター。 アプリケーションがソートキーの生成 (LCMAP_SORTKEY) にこの関数を使用している場合:
呼び出し元が文字列の一部を明示的に要求した場合、cchDest で指定しない限り、出力先の文字列には終端の null 文字は含まれません。 この関数が失敗した場合、出力先バッファーには部分的な結果が含まれるか、まったく結果が含まれないことがあります。この場合、すべての結果は無効とみなすべきです。 メモ
LCMAP_UPPERCASE または LCMAP_LOWERCASE を設定する場合、出力先文字列にソース文字列と同じバッファーを使用できます。ただし、変換後の大文字・小文字変換後の文字列の長さが異なる結果になる条件があるため、これは強く推奨されません。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| cchDest | INT | in | lpDestStr で示される出力先文字列のサイズ (文字数)。アプリケーションが文字列マッピングに関数を使用している場合、このパラメーターには文字数を指定します。終端の null 文字のための領域が cchSrc に含まれている場合は、cchDest にも終端の null 文字のための領域を含める必要があります。 アプリケーションがソートキーの生成に関数を使用している場合、サイズとしてバイト数を指定します。このバイト数には、ソートキーの 0x00 終端文字のための領域を含める必要があります。 アプリケーションは cchDest に 0 を設定できます。この場合、関数は lpDestStr パラメーターを使用せず、マップ後の文字列またはソートキーに必要なバッファーサイズを返します。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| lpVersionInformation | NLSVERSIONINFO* | inoptional | 関連する NLS 機能のバージョン情報を含む NLSVERSIONINFOEX 構造体へのポインター。通常は GetNLSVersionEx から取得します。 Windows Vista、Windows 7: 予約済み。NULL を設定する必要があります。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| lpReserved | void* | inoptional | 予約済み。NULL にする必要があります。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sortHandle | LPARAM | in | 予約済み。0 にする必要があります。 メモ
CompareStringEx と LCMapStringEx は、(ロケール名が null の場合に) ソートハンドルを指定できます。この使用法はほとんどのアプリでは推奨されません。 |
戻り値の型: INT
公式ドキュメント
名前で指定されたロケールについて、入力文字列に指定された変換を適用して別の文字列にマップするか、または入力文字列のソートキーを生成します。注意 Windows Vista 以降でのみ動作するように設計されている場合、アプリケーションは LCMapString よりもこの関数を優先して呼び出してください。
戻り値
文字列マッピングに使用した場合、関数が成功すると変換後の文字列の文字数を返します (詳細は cchSrc および cchDest を参照してください)。
ソートキーの生成に使用した場合、関数が成功するとソートキーのバイト数を返します。
この関数は、成功しなかった場合は 0 を返します。拡張エラー情報を取得するには、アプリケーションは GetLastError を呼び出すことができます。これは次のいずれかのエラーコードを返すことがあります。
- ERROR_INSUFFICIENT_BUFFER。指定されたバッファーサイズが十分な大きさでなかったか、誤って NULL に設定されていました。
- ERROR_INVALID_FLAGS。フラグに指定された値が無効でした。
- ERROR_INVALID_PARAMETER。いずれかのパラメーター値が無効でした。
解説(Remarks)
アプリケーションは LCMapString または LCMapStringEx を使用してソートキーを生成できます。これを行うには、アプリケーションは dwMapFlags パラメーターに LCMAP_SORTKEY を指定します。詳細については、アプリケーションでのソートの処理を参照してください。
ソートキーは不透明なバイトストリームです。呼び出し元は、API が返す長さのバイト配列として扱い、内部構造があるように見えてもそれに依存すべきではありません。返されるソートキー内のバイトには 0 が 0 個、1 個、または複数含まれている可能性があります。ゼロバイトが存在するか否かは想定すべきではありません。
アプリケーションが LCMapString または LCMapStringEx を使用するもう 1 つの方法は、文字列のマッピングです。この場合、アプリケーションは dwMapFlags パラメーターに LCMAP_SORTKEY を指定せず、それ以外のフラグの組み合わせを指定します。詳細については、アプリケーションでのソートの処理を参照してください。
Windows Vista 以降: この関数はカスタムロケールのデータを扱えます。データはコンピューター間やアプリケーションの実行ごとに同一であることは保証されません。アプリケーションがデータを永続化または送信する必要がある場合は、永続的なロケールデータの使用を参照してください。
Windows 8 以降: アプリが Windows.Globalization 名前空間の言語タグをこの関数に渡す場合は、まず ResolveLocaleName を呼び出してタグを変換する必要があります。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// 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 // INTfunction 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)。const std = @import("std");
extern "kernel32" fn LCMapStringEx(
lpLocaleName: [*c]const u16, // LPCWSTR optional
dwMapFlags: u32, // DWORD
lpSrcStr: [*c]const u16, // LPCWSTR
cchSrc: i32, // INT
lpDestStr: [*c]u16, // LPWSTR optional, out
cchDest: i32, // INT
lpVersionInformation: [*c]NLSVERSIONINFO, // NLSVERSIONINFO* optional
lpReserved: ?*anyopaque, // void* optional
sortHandle: isize // LPARAM
) callconv(std.os.windows.WINAPI) i32;proc LCMapStringEx(
lpLocaleName: WideCString, # LPCWSTR optional
dwMapFlags: uint32, # DWORD
lpSrcStr: WideCString, # LPCWSTR
cchSrc: int32, # INT
lpDestStr: ptr uint16, # LPWSTR optional, out
cchDest: int32, # INT
lpVersionInformation: ptr NLSVERSIONINFO, # NLSVERSIONINFO* optional
lpReserved: pointer, # void* optional
sortHandle: int # LPARAM
): int32 {.importc: "LCMapStringEx", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int LCMapStringEx(
const(wchar)* lpLocaleName, // LPCWSTR optional
uint dwMapFlags, // DWORD
const(wchar)* lpSrcStr, // LPCWSTR
int cchSrc, // INT
wchar* lpDestStr, // LPWSTR optional, out
int cchDest, // INT
NLSVERSIONINFO* lpVersionInformation, // NLSVERSIONINFO* optional
void* lpReserved, // void* optional
ptrdiff_t sortHandle // LPARAM
);ccall((:LCMapStringEx, "KERNEL32.dll"), stdcall, Int32,
(Cwstring, UInt32, Cwstring, Int32, Ptr{UInt16}, Int32, Ptr{NLSVERSIONINFO}, Ptr{Cvoid}, Int),
lpLocaleName, dwMapFlags, lpSrcStr, cchSrc, lpDestStr, cchDest, lpVersionInformation, lpReserved, sortHandle)
# lpLocaleName : LPCWSTR optional -> Cwstring
# dwMapFlags : DWORD -> UInt32
# lpSrcStr : LPCWSTR -> Cwstring
# cchSrc : INT -> Int32
# lpDestStr : LPWSTR optional, out -> Ptr{UInt16}
# cchDest : INT -> Int32
# lpVersionInformation : NLSVERSIONINFO* optional -> Ptr{NLSVERSIONINFO}
# lpReserved : void* optional -> Ptr{Cvoid}
# sortHandle : LPARAM -> Int
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t LCMapStringEx(
const uint16_t* lpLocaleName,
uint32_t dwMapFlags,
const uint16_t* lpSrcStr,
int32_t cchSrc,
uint16_t* lpDestStr,
int32_t cchDest,
void* lpVersionInformation,
void* lpReserved,
intptr_t sortHandle);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.LCMapStringEx(lpLocaleName, dwMapFlags, lpSrcStr, cchSrc, lpDestStr, cchDest, lpVersionInformation, lpReserved, sortHandle)
-- lpLocaleName : LPCWSTR optional
-- dwMapFlags : DWORD
-- lpSrcStr : LPCWSTR
-- cchSrc : INT
-- lpDestStr : LPWSTR optional, out
-- cchDest : INT
-- lpVersionInformation : NLSVERSIONINFO* optional
-- lpReserved : void* optional
-- sortHandle : LPARAM
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const LCMapStringEx = lib.func('__stdcall', 'LCMapStringEx', 'int32_t', ['str16', 'uint32_t', 'str16', 'int32_t', 'uint16_t *', 'int32_t', 'void *', 'void *', 'intptr_t']);
// LCMapStringEx(lpLocaleName, dwMapFlags, lpSrcStr, cchSrc, lpDestStr, cchDest, lpVersionInformation, lpReserved, sortHandle)
// lpLocaleName : LPCWSTR optional -> 'str16'
// dwMapFlags : DWORD -> 'uint32_t'
// lpSrcStr : LPCWSTR -> 'str16'
// cchSrc : INT -> 'int32_t'
// lpDestStr : LPWSTR optional, out -> 'uint16_t *'
// cchDest : INT -> 'int32_t'
// lpVersionInformation : NLSVERSIONINFO* optional -> 'void *'
// lpReserved : void* optional -> 'void *'
// sortHandle : LPARAM -> 'intptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
LCMapStringEx: { parameters: ["buffer", "u32", "buffer", "i32", "buffer", "i32", "pointer", "pointer", "isize"], result: "i32" },
});
// lib.symbols.LCMapStringEx(lpLocaleName, dwMapFlags, lpSrcStr, cchSrc, lpDestStr, cchDest, lpVersionInformation, lpReserved, sortHandle)
// lpLocaleName : LPCWSTR optional -> "buffer"
// dwMapFlags : DWORD -> "u32"
// lpSrcStr : LPCWSTR -> "buffer"
// cchSrc : INT -> "i32"
// lpDestStr : LPWSTR optional, out -> "buffer"
// cchDest : INT -> "i32"
// lpVersionInformation : NLSVERSIONINFO* optional -> "pointer"
// lpReserved : void* optional -> "pointer"
// sortHandle : LPARAM -> "isize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t LCMapStringEx(
const uint16_t* lpLocaleName,
uint32_t dwMapFlags,
const uint16_t* lpSrcStr,
int32_t cchSrc,
uint16_t* lpDestStr,
int32_t cchDest,
void* lpVersionInformation,
void* lpReserved,
intptr_t sortHandle);
C, "KERNEL32.dll");
// $ffi->LCMapStringEx(lpLocaleName, dwMapFlags, lpSrcStr, cchSrc, lpDestStr, cchDest, lpVersionInformation, lpReserved, sortHandle);
// lpLocaleName : LPCWSTR optional
// dwMapFlags : DWORD
// lpSrcStr : LPCWSTR
// cchSrc : INT
// lpDestStr : LPWSTR optional, out
// cchDest : INT
// lpVersionInformation : NLSVERSIONINFO* optional
// lpReserved : void* optional
// sortHandle : LPARAM
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Kernel32 extends StdCallLibrary {
Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
int LCMapStringEx(
WString lpLocaleName, // LPCWSTR optional
int dwMapFlags, // DWORD
WString lpSrcStr, // LPCWSTR
int cchSrc, // INT
char[] lpDestStr, // LPWSTR optional, out
int cchDest, // INT
Pointer lpVersionInformation, // NLSVERSIONINFO* optional
Pointer lpReserved, // void* optional
long sortHandle // LPARAM
);
}@[Link("kernel32")]
lib LibKERNEL32
fun LCMapStringEx = LCMapStringEx(
lpLocaleName : UInt16*, # LPCWSTR optional
dwMapFlags : UInt32, # DWORD
lpSrcStr : UInt16*, # LPCWSTR
cchSrc : Int32, # INT
lpDestStr : UInt16*, # LPWSTR optional, out
cchDest : Int32, # INT
lpVersionInformation : NLSVERSIONINFO*, # NLSVERSIONINFO* optional
lpReserved : Void*, # void* optional
sortHandle : LibC::SSizeT # LPARAM
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef LCMapStringExNative = Int32 Function(Pointer<Utf16>, Uint32, Pointer<Utf16>, Int32, Pointer<Utf16>, Int32, Pointer<Void>, Pointer<Void>, IntPtr);
typedef LCMapStringExDart = int Function(Pointer<Utf16>, int, Pointer<Utf16>, int, Pointer<Utf16>, int, Pointer<Void>, Pointer<Void>, int);
final LCMapStringEx = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<LCMapStringExNative, LCMapStringExDart>('LCMapStringEx');
// lpLocaleName : LPCWSTR optional -> Pointer<Utf16>
// dwMapFlags : DWORD -> Uint32
// lpSrcStr : LPCWSTR -> Pointer<Utf16>
// cchSrc : INT -> Int32
// lpDestStr : LPWSTR optional, out -> Pointer<Utf16>
// cchDest : INT -> Int32
// lpVersionInformation : NLSVERSIONINFO* optional -> Pointer<Void>
// lpReserved : void* optional -> Pointer<Void>
// sortHandle : LPARAM -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
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';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "LCMapStringEx"
c_LCMapStringEx :: CWString -> Word32 -> CWString -> Int32 -> CWString -> Int32 -> Ptr () -> Ptr () -> CIntPtr -> IO Int32
-- lpLocaleName : LPCWSTR optional -> CWString
-- dwMapFlags : DWORD -> Word32
-- lpSrcStr : LPCWSTR -> CWString
-- cchSrc : INT -> Int32
-- lpDestStr : LPWSTR optional, out -> CWString
-- cchDest : INT -> Int32
-- lpVersionInformation : NLSVERSIONINFO* optional -> Ptr ()
-- lpReserved : void* optional -> Ptr ()
-- sortHandle : LPARAM -> CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let lcmapstringex =
foreign "LCMapStringEx"
((ptr uint16_t) @-> uint32_t @-> (ptr uint16_t) @-> int32_t @-> (ptr uint16_t) @-> int32_t @-> (ptr void) @-> (ptr void) @-> intptr_t @-> returning int32_t)
(* lpLocaleName : LPCWSTR optional -> (ptr uint16_t) *)
(* dwMapFlags : DWORD -> uint32_t *)
(* lpSrcStr : LPCWSTR -> (ptr uint16_t) *)
(* cchSrc : INT -> int32_t *)
(* lpDestStr : LPWSTR optional, out -> (ptr uint16_t) *)
(* cchDest : INT -> int32_t *)
(* lpVersionInformation : NLSVERSIONINFO* optional -> (ptr void) *)
(* lpReserved : void* optional -> (ptr void) *)
(* sortHandle : LPARAM -> intptr_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("LCMapStringEx" lcmap-string-ex :convention :stdcall) :int32
(lp-locale-name (:string :encoding :utf-16le)) ; LPCWSTR optional
(dw-map-flags :uint32) ; DWORD
(lp-src-str (:string :encoding :utf-16le)) ; LPCWSTR
(cch-src :int32) ; INT
(lp-dest-str :pointer) ; LPWSTR optional, out
(cch-dest :int32) ; INT
(lp-version-information :pointer) ; NLSVERSIONINFO* optional
(lp-reserved :pointer) ; void* optional
(sort-handle :int64)) ; LPARAM
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $LCMapStringEx = Win32::API::More->new('KERNEL32',
'int LCMapStringEx(LPCWSTR lpLocaleName, DWORD dwMapFlags, LPCWSTR lpSrcStr, int cchSrc, LPWSTR lpDestStr, int cchDest, LPVOID lpVersionInformation, LPVOID lpReserved, LPARAM sortHandle)');
# my $ret = $LCMapStringEx->Call($lpLocaleName, $dwMapFlags, $lpSrcStr, $cchSrc, $lpDestStr, $cchDest, $lpVersionInformation, $lpReserved, $sortHandle);
# lpLocaleName : LPCWSTR optional -> LPCWSTR
# dwMapFlags : DWORD -> DWORD
# lpSrcStr : LPCWSTR -> LPCWSTR
# cchSrc : INT -> int
# lpDestStr : LPWSTR optional, out -> LPWSTR
# cchDest : INT -> int
# lpVersionInformation : NLSVERSIONINFO* optional -> LPVOID
# lpReserved : void* optional -> LPVOID
# sortHandle : LPARAM -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f LCMapStringW — Unicode文字列にロケール依存のマッピング変換を行う。
- f CompareStringW — ロケールに従い二つのUnicode文字列を比較する。
- f FindNLSStringEx — ロケール名を指定して文字列内から部分文字列を検索する。
- f GetNLSVersionEx — 指定ロケールのNLS機能のバージョン情報を取得する。