Win32 API 日本語リファレンス
ホームGlobalization › ucol_getFunctionalEquivalent

ucol_getFunctionalEquivalent

関数
指定ロケールと機能的に等価な照合ロケールを取得する。
DLLicuin.dll呼出規約cdecl

シグネチャ

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

INT ucol_getFunctionalEquivalent(
    LPSTR result,
    INT resultCapacity,
    LPCSTR keyword,
    LPCSTR locale,
    CHAR* isAvailable,
    UErrorCode* status
);

パラメーター

名前方向説明
resultLPSTRin機能的に等価なロケール名を書き込む出力バッファ。
resultCapacityINTinresultバッファの容量(バイト数)。
keywordLPCSTRin等価判定に用いるキーワード文字列(例:collation)。
localeLPCSTRin基準となるロケールの識別子文字列。
isAvailableCHAR*inout指定ロケールに直接対応データが存在するか否かを受け取る出力フラグ。NULL可。
statusUErrorCode*inoutエラーコードへのポインタ。呼び出し前に初期化する必要がある。

戻り値の型: INT

各言語での呼び出し定義

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

INT ucol_getFunctionalEquivalent(
    LPSTR result,
    INT resultCapacity,
    LPCSTR keyword,
    LPCSTR locale,
    CHAR* isAvailable,
    UErrorCode* status
);
[DllImport("icuin.dll", ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern int ucol_getFunctionalEquivalent(
    [MarshalAs(UnmanagedType.LPStr)] string result,   // LPSTR
    int resultCapacity,   // INT
    [MarshalAs(UnmanagedType.LPStr)] string keyword,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string locale,   // LPCSTR
    IntPtr isAvailable,   // CHAR* in/out
    ref int status   // UErrorCode* in/out
);
<DllImport("icuin.dll", ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Function ucol_getFunctionalEquivalent(
    <MarshalAs(UnmanagedType.LPStr)> result As String,   ' LPSTR
    resultCapacity As Integer,   ' INT
    <MarshalAs(UnmanagedType.LPStr)> keyword As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> locale As String,   ' LPCSTR
    isAvailable As IntPtr,   ' CHAR* in/out
    ByRef status As Integer   ' UErrorCode* in/out
) As Integer
End Function
' result : LPSTR
' resultCapacity : INT
' keyword : LPCSTR
' locale : LPCSTR
' isAvailable : CHAR* in/out
' status : UErrorCode* in/out
Declare PtrSafe Function ucol_getFunctionalEquivalent Lib "icuin" ( _
    ByVal result As String, _
    ByVal resultCapacity As Long, _
    ByVal keyword As String, _
    ByVal locale As String, _
    ByVal isAvailable As LongPtr, _
    ByRef status As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ucol_getFunctionalEquivalent = ctypes.cdll.icuin.ucol_getFunctionalEquivalent
ucol_getFunctionalEquivalent.restype = ctypes.c_int
ucol_getFunctionalEquivalent.argtypes = [
    wintypes.LPCSTR,  # result : LPSTR
    ctypes.c_int,  # resultCapacity : INT
    wintypes.LPCSTR,  # keyword : LPCSTR
    wintypes.LPCSTR,  # locale : LPCSTR
    ctypes.POINTER(ctypes.c_byte),  # isAvailable : CHAR* in/out
    ctypes.c_void_p,  # status : UErrorCode* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('icuin.dll')
ucol_getFunctionalEquivalent = Fiddle::Function.new(
  lib['ucol_getFunctionalEquivalent'],
  [
    Fiddle::TYPE_VOIDP,  # result : LPSTR
    Fiddle::TYPE_INT,  # resultCapacity : INT
    Fiddle::TYPE_VOIDP,  # keyword : LPCSTR
    Fiddle::TYPE_VOIDP,  # locale : LPCSTR
    Fiddle::TYPE_VOIDP,  # isAvailable : CHAR* in/out
    Fiddle::TYPE_VOIDP,  # status : UErrorCode* in/out
  ],
  Fiddle::TYPE_INT, Fiddle::Function::CDECL)
#[link(name = "icuin")]
extern "C" {
    fn ucol_getFunctionalEquivalent(
        result: *mut u8,  // LPSTR
        resultCapacity: i32,  // INT
        keyword: *const u8,  // LPCSTR
        locale: *const u8,  // LPCSTR
        isAvailable: *mut i8,  // CHAR* in/out
        status: *mut i32  // UErrorCode* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("icuin.dll", CallingConvention = CallingConvention.Cdecl)]
public static extern int ucol_getFunctionalEquivalent([MarshalAs(UnmanagedType.LPStr)] string result, int resultCapacity, [MarshalAs(UnmanagedType.LPStr)] string keyword, [MarshalAs(UnmanagedType.LPStr)] string locale, IntPtr isAvailable, ref int status);
"@
$api = Add-Type -MemberDefinition $sig -Name 'icuin_ucol_getFunctionalEquivalent' -Namespace Win32 -PassThru
# $api::ucol_getFunctionalEquivalent(result, resultCapacity, keyword, locale, isAvailable, status)
#uselib "icuin.dll"
#func global ucol_getFunctionalEquivalent "ucol_getFunctionalEquivalent" sptr, sptr, sptr, sptr, sptr, sptr
; ucol_getFunctionalEquivalent result, resultCapacity, keyword, locale, varptr(isAvailable), varptr(status)   ; 戻り値は stat
; result : LPSTR -> "sptr"
; resultCapacity : INT -> "sptr"
; keyword : LPCSTR -> "sptr"
; locale : LPCSTR -> "sptr"
; isAvailable : CHAR* in/out -> "sptr"
; status : UErrorCode* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "icuin.dll"
#cfunc global ucol_getFunctionalEquivalent "ucol_getFunctionalEquivalent" str, int, str, str, var, var
; res = ucol_getFunctionalEquivalent(result, resultCapacity, keyword, locale, isAvailable, status)
; result : LPSTR -> "str"
; resultCapacity : INT -> "int"
; keyword : LPCSTR -> "str"
; locale : LPCSTR -> "str"
; isAvailable : CHAR* in/out -> "var"
; status : UErrorCode* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT ucol_getFunctionalEquivalent(LPSTR result, INT resultCapacity, LPCSTR keyword, LPCSTR locale, CHAR* isAvailable, UErrorCode* status)
#uselib "icuin.dll"
#cfunc global ucol_getFunctionalEquivalent "ucol_getFunctionalEquivalent" str, int, str, str, var, var
; res = ucol_getFunctionalEquivalent(result, resultCapacity, keyword, locale, isAvailable, status)
; result : LPSTR -> "str"
; resultCapacity : INT -> "int"
; keyword : LPCSTR -> "str"
; locale : LPCSTR -> "str"
; isAvailable : CHAR* in/out -> "var"
; status : UErrorCode* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	icuin = windows.NewLazySystemDLL("icuin.dll")
	procucol_getFunctionalEquivalent = icuin.NewProc("ucol_getFunctionalEquivalent")
)

// result (LPSTR), resultCapacity (INT), keyword (LPCSTR), locale (LPCSTR), isAvailable (CHAR* in/out), status (UErrorCode* in/out)
r1, _, err := procucol_getFunctionalEquivalent.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(result))),
	uintptr(resultCapacity),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(keyword))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(locale))),
	uintptr(isAvailable),
	uintptr(status),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function ucol_getFunctionalEquivalent(
  result: PAnsiChar;   // LPSTR
  resultCapacity: Integer;   // INT
  keyword: PAnsiChar;   // LPCSTR
  locale: PAnsiChar;   // LPCSTR
  isAvailable: Pointer;   // CHAR* in/out
  status: Pointer   // UErrorCode* in/out
): Integer; cdecl;
  external 'icuin.dll' name 'ucol_getFunctionalEquivalent';
result := DllCall("icuin\ucol_getFunctionalEquivalent"
    , "AStr", result   ; LPSTR
    , "Int", resultCapacity   ; INT
    , "AStr", keyword   ; LPCSTR
    , "AStr", locale   ; LPCSTR
    , "Ptr", isAvailable   ; CHAR* in/out
    , "Ptr", status   ; UErrorCode* in/out
    , "Cdecl Int")   ; return: INT
●ucol_getFunctionalEquivalent(result, resultCapacity, keyword, locale, isAvailable, status) = DLL("icuin.dll", "int ucol_getFunctionalEquivalent(char*, int, char*, char*, void*, void*)")
# 呼び出し: ucol_getFunctionalEquivalent(result, resultCapacity, keyword, locale, isAvailable, status)
# result : LPSTR -> "char*"
# resultCapacity : INT -> "int"
# keyword : LPCSTR -> "char*"
# locale : LPCSTR -> "char*"
# isAvailable : CHAR* in/out -> "void*"
# status : UErrorCode* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※cdecl関数。DLL()宣言はstdcall前提。cdeclは EXEC_PTR(`cdecl`,…) を使用。
const std = @import("std");

extern "icuin" fn ucol_getFunctionalEquivalent(
    result: [*c]const u8, // LPSTR
    resultCapacity: i32, // INT
    keyword: [*c]const u8, // LPCSTR
    locale: [*c]const u8, // LPCSTR
    isAvailable: [*c]i8, // CHAR* in/out
    status: [*c]i32 // UErrorCode* in/out
) callconv(.c) i32;
proc ucol_getFunctionalEquivalent(
    result: cstring,  # LPSTR
    resultCapacity: int32,  # INT
    keyword: cstring,  # LPCSTR
    locale: cstring,  # LPCSTR
    isAvailable: ptr int8,  # CHAR* in/out
    status: ptr int32  # UErrorCode* in/out
): int32 {.importc: "ucol_getFunctionalEquivalent", cdecl, dynlib: "icuin.dll".}
pragma(lib, "icuin");
extern(C)
int ucol_getFunctionalEquivalent(
    const(char)* result,   // LPSTR
    int resultCapacity,   // INT
    const(char)* keyword,   // LPCSTR
    const(char)* locale,   // LPCSTR
    byte* isAvailable,   // CHAR* in/out
    int* status   // UErrorCode* in/out
);
ccall((:ucol_getFunctionalEquivalent, "icuin.dll"), Int32,
      (Cstring, Int32, Cstring, Cstring, Ptr{Int8}, Ptr{Int32}),
      result, resultCapacity, keyword, locale, isAvailable, status)
# result : LPSTR -> Cstring
# resultCapacity : INT -> Int32
# keyword : LPCSTR -> Cstring
# locale : LPCSTR -> Cstring
# isAvailable : CHAR* in/out -> Ptr{Int8}
# status : UErrorCode* in/out -> Ptr{Int32}
local ffi = require("ffi")
ffi.cdef[[
int32_t ucol_getFunctionalEquivalent(
    const char* result,
    int32_t resultCapacity,
    const char* keyword,
    const char* locale,
    int8_t* isAvailable,
    int32_t* status);
]]
local icuin = ffi.load("icuin")
-- icuin.ucol_getFunctionalEquivalent(result, resultCapacity, keyword, locale, isAvailable, status)
-- result : LPSTR
-- resultCapacity : INT
-- keyword : LPCSTR
-- locale : LPCSTR
-- isAvailable : CHAR* in/out
-- status : UErrorCode* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('icuin.dll');
const ucol_getFunctionalEquivalent = lib.func('__cdecl', 'ucol_getFunctionalEquivalent', 'int32_t', ['str', 'int32_t', 'str', 'str', 'int8_t *', 'int32_t *']);
// ucol_getFunctionalEquivalent(result, resultCapacity, keyword, locale, isAvailable, status)
// result : LPSTR -> 'str'
// resultCapacity : INT -> 'int32_t'
// keyword : LPCSTR -> 'str'
// locale : LPCSTR -> 'str'
// isAvailable : CHAR* in/out -> 'int8_t *'
// status : UErrorCode* in/out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("icuin.dll", {
  ucol_getFunctionalEquivalent: { parameters: ["buffer", "i32", "buffer", "buffer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.ucol_getFunctionalEquivalent(result, resultCapacity, keyword, locale, isAvailable, status)
// result : LPSTR -> "buffer"
// resultCapacity : INT -> "i32"
// keyword : LPCSTR -> "buffer"
// locale : LPCSTR -> "buffer"
// isAvailable : CHAR* in/out -> "pointer"
// status : UErrorCode* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ucol_getFunctionalEquivalent(
    const char* result,
    int32_t resultCapacity,
    const char* keyword,
    const char* locale,
    int8_t* isAvailable,
    int32_t* status);
C, "icuin.dll");
// $ffi->ucol_getFunctionalEquivalent(result, resultCapacity, keyword, locale, isAvailable, status);
// result : LPSTR
// resultCapacity : INT
// keyword : LPCSTR
// locale : LPCSTR
// isAvailable : CHAR* in/out
// status : UErrorCode* in/out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Icuin extends Library {
    Icuin INSTANCE = Native.load("icuin", Icuin.class);
    int ucol_getFunctionalEquivalent(
        String result,   // LPSTR
        int resultCapacity,   // INT
        String keyword,   // LPCSTR
        String locale,   // LPCSTR
        byte[] isAvailable,   // CHAR* in/out
        IntByReference status   // UErrorCode* in/out
    );
}
@[Link("icuin")]
lib Libicuin
  fun ucol_getFunctionalEquivalent = ucol_getFunctionalEquivalent(
    result : UInt8*,   # LPSTR
    resultCapacity : Int32,   # INT
    keyword : UInt8*,   # LPCSTR
    locale : UInt8*,   # LPCSTR
    isAvailable : Int8*,   # CHAR* in/out
    status : Int32*   # UErrorCode* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ucol_getFunctionalEquivalentNative = Int32 Function(Pointer<Utf8>, Int32, Pointer<Utf8>, Pointer<Utf8>, Pointer<Int8>, Pointer<Int32>);
typedef ucol_getFunctionalEquivalentDart = int Function(Pointer<Utf8>, int, Pointer<Utf8>, Pointer<Utf8>, Pointer<Int8>, Pointer<Int32>);
final ucol_getFunctionalEquivalent = DynamicLibrary.open('icuin.dll')
    .lookupFunction<ucol_getFunctionalEquivalentNative, ucol_getFunctionalEquivalentDart>('ucol_getFunctionalEquivalent');
// result : LPSTR -> Pointer<Utf8>
// resultCapacity : INT -> Int32
// keyword : LPCSTR -> Pointer<Utf8>
// locale : LPCSTR -> Pointer<Utf8>
// isAvailable : CHAR* in/out -> Pointer<Int8>
// status : UErrorCode* in/out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ucol_getFunctionalEquivalent(
  result: PAnsiChar;   // LPSTR
  resultCapacity: Integer;   // INT
  keyword: PAnsiChar;   // LPCSTR
  locale: PAnsiChar;   // LPCSTR
  isAvailable: Pointer;   // CHAR* in/out
  status: Pointer   // UErrorCode* in/out
): Integer; cdecl;
  external 'icuin.dll' name 'ucol_getFunctionalEquivalent';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import ccall safe "ucol_getFunctionalEquivalent"
  c_ucol_getFunctionalEquivalent :: CString -> Int32 -> CString -> CString -> Ptr Int8 -> Ptr Int32 -> IO Int32
-- result : LPSTR -> CString
-- resultCapacity : INT -> Int32
-- keyword : LPCSTR -> CString
-- locale : LPCSTR -> CString
-- isAvailable : CHAR* in/out -> Ptr Int8
-- status : UErrorCode* in/out -> Ptr Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ucol_getfunctionalequivalent =
  foreign "ucol_getFunctionalEquivalent"
    (string @-> int32_t @-> string @-> string @-> (ptr int8_t) @-> (ptr int32_t) @-> returning int32_t)
(* result : LPSTR -> string *)
(* resultCapacity : INT -> int32_t *)
(* keyword : LPCSTR -> string *)
(* locale : LPCSTR -> string *)
(* isAvailable : CHAR* in/out -> (ptr int8_t) *)
(* status : UErrorCode* in/out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library icuin (t "icuin.dll"))
(cffi:use-foreign-library icuin)

(cffi:defcfun ("ucol_getFunctionalEquivalent" ucol-get-functional-equivalent :convention :cdecl) :int32
  (result :string)   ; LPSTR
  (result-capacity :int32)   ; INT
  (keyword :string)   ; LPCSTR
  (locale :string)   ; LPCSTR
  (is-available :pointer)   ; CHAR* in/out
  (status :pointer))   ; UErrorCode* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ucol_getFunctionalEquivalent = Win32::API::More->new('icuin',
    'int ucol_getFunctionalEquivalent(LPCSTR result, int resultCapacity, LPCSTR keyword, LPCSTR locale, LPVOID isAvailable, LPVOID status)');
# my $ret = $ucol_getFunctionalEquivalent->Call($result, $resultCapacity, $keyword, $locale, $isAvailable, $status);
# result : LPSTR -> LPCSTR
# resultCapacity : INT -> int
# keyword : LPCSTR -> LPCSTR
# locale : LPCSTR -> LPCSTR
# isAvailable : CHAR* in/out -> LPVOID
# status : UErrorCode* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型