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

ucol_getSortKey

関数
文字列から照合用のソートキーを生成する。
DLLicuin.dll呼出規約cdecl

シグネチャ

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

INT ucol_getSortKey(
    const UCollator* coll,
    const WORD* source,
    INT sourceLength,
    BYTE* result,
    INT resultLength
);

パラメーター

名前方向説明
collUCollator*inソートキー生成に用いるコレーターハンドル。
sourceWORD*inソートキーを生成する元のUTF-16文字列(WORD配列)。
sourceLengthINTinsource文字列の長さ。-1でNUL終端文字列として扱う。
resultBYTE*inout生成されたソートキーを書き込む出力バイトバッファ。
resultLengthINTinresultバッファの容量(バイト数)。0で必要長を取得する。

戻り値の型: INT

各言語での呼び出し定義

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

INT ucol_getSortKey(
    const UCollator* coll,
    const WORD* source,
    INT sourceLength,
    BYTE* result,
    INT resultLength
);
[DllImport("icuin.dll", ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern int ucol_getSortKey(
    ref IntPtr coll,   // UCollator*
    ref ushort source,   // WORD*
    int sourceLength,   // INT
    IntPtr result,   // BYTE* in/out
    int resultLength   // INT
);
<DllImport("icuin.dll", ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Function ucol_getSortKey(
    ByRef coll As IntPtr,   ' UCollator*
    ByRef source As UShort,   ' WORD*
    sourceLength As Integer,   ' INT
    result As IntPtr,   ' BYTE* in/out
    resultLength As Integer   ' INT
) As Integer
End Function
' coll : UCollator*
' source : WORD*
' sourceLength : INT
' result : BYTE* in/out
' resultLength : INT
Declare PtrSafe Function ucol_getSortKey Lib "icuin" ( _
    ByRef coll As LongPtr, _
    ByRef source As Integer, _
    ByVal sourceLength As Long, _
    ByVal result As LongPtr, _
    ByVal resultLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ucol_getSortKey = ctypes.cdll.icuin.ucol_getSortKey
ucol_getSortKey.restype = ctypes.c_int
ucol_getSortKey.argtypes = [
    ctypes.c_void_p,  # coll : UCollator*
    ctypes.POINTER(ctypes.c_ushort),  # source : WORD*
    ctypes.c_int,  # sourceLength : INT
    ctypes.POINTER(ctypes.c_ubyte),  # result : BYTE* in/out
    ctypes.c_int,  # resultLength : INT
]
require 'fiddle'
require 'fiddle/import'

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

var (
	icuin = windows.NewLazySystemDLL("icuin.dll")
	procucol_getSortKey = icuin.NewProc("ucol_getSortKey")
)

// coll (UCollator*), source (WORD*), sourceLength (INT), result (BYTE* in/out), resultLength (INT)
r1, _, err := procucol_getSortKey.Call(
	uintptr(coll),
	uintptr(source),
	uintptr(sourceLength),
	uintptr(result),
	uintptr(resultLength),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function ucol_getSortKey(
  coll: Pointer;   // UCollator*
  source: Pointer;   // WORD*
  sourceLength: Integer;   // INT
  result: Pointer;   // BYTE* in/out
  resultLength: Integer   // INT
): Integer; cdecl;
  external 'icuin.dll' name 'ucol_getSortKey';
result := DllCall("icuin\ucol_getSortKey"
    , "Ptr", coll   ; UCollator*
    , "Ptr", source   ; WORD*
    , "Int", sourceLength   ; INT
    , "Ptr", result   ; BYTE* in/out
    , "Int", resultLength   ; INT
    , "Cdecl Int")   ; return: INT
●ucol_getSortKey(coll, source, sourceLength, result, resultLength) = DLL("icuin.dll", "int ucol_getSortKey(void*, void*, int, void*, int)")
# 呼び出し: ucol_getSortKey(coll, source, sourceLength, result, resultLength)
# coll : UCollator* -> "void*"
# source : WORD* -> "void*"
# sourceLength : INT -> "int"
# result : BYTE* in/out -> "void*"
# resultLength : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※cdecl関数。DLL()宣言はstdcall前提。cdeclは EXEC_PTR(`cdecl`,…) を使用。
const std = @import("std");

extern "icuin" fn ucol_getSortKey(
    coll: [*c]isize, // UCollator*
    source: [*c]u16, // WORD*
    sourceLength: i32, // INT
    result: [*c]u8, // BYTE* in/out
    resultLength: i32 // INT
) callconv(.c) i32;
proc ucol_getSortKey(
    coll: ptr int,  # UCollator*
    source: ptr uint16,  # WORD*
    sourceLength: int32,  # INT
    result: ptr uint8,  # BYTE* in/out
    resultLength: int32  # INT
): int32 {.importc: "ucol_getSortKey", cdecl, dynlib: "icuin.dll".}
pragma(lib, "icuin");
extern(C)
int ucol_getSortKey(
    ptrdiff_t* coll,   // UCollator*
    ushort* source,   // WORD*
    int sourceLength,   // INT
    ubyte* result,   // BYTE* in/out
    int resultLength   // INT
);
ccall((:ucol_getSortKey, "icuin.dll"), Int32,
      (Ptr{Int}, Ptr{UInt16}, Int32, Ptr{UInt8}, Int32),
      coll, source, sourceLength, result, resultLength)
# coll : UCollator* -> Ptr{Int}
# source : WORD* -> Ptr{UInt16}
# sourceLength : INT -> Int32
# result : BYTE* in/out -> Ptr{UInt8}
# resultLength : INT -> Int32
local ffi = require("ffi")
ffi.cdef[[
int32_t ucol_getSortKey(
    intptr_t* coll,
    uint16_t* source,
    int32_t sourceLength,
    uint8_t* result,
    int32_t resultLength);
]]
local icuin = ffi.load("icuin")
-- icuin.ucol_getSortKey(coll, source, sourceLength, result, resultLength)
-- coll : UCollator*
-- source : WORD*
-- sourceLength : INT
-- result : BYTE* in/out
-- resultLength : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('icuin.dll');
const ucol_getSortKey = lib.func('__cdecl', 'ucol_getSortKey', 'int32_t', ['intptr_t *', 'uint16_t *', 'int32_t', 'uint8_t *', 'int32_t']);
// ucol_getSortKey(coll, source, sourceLength, result, resultLength)
// coll : UCollator* -> 'intptr_t *'
// source : WORD* -> 'uint16_t *'
// sourceLength : INT -> 'int32_t'
// result : BYTE* in/out -> 'uint8_t *'
// resultLength : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("icuin.dll", {
  ucol_getSortKey: { parameters: ["pointer", "pointer", "i32", "pointer", "i32"], result: "i32" },
});
// lib.symbols.ucol_getSortKey(coll, source, sourceLength, result, resultLength)
// coll : UCollator* -> "pointer"
// source : WORD* -> "pointer"
// sourceLength : INT -> "i32"
// result : BYTE* in/out -> "pointer"
// resultLength : INT -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ucol_getSortKey(
    intptr_t* coll,
    uint16_t* source,
    int32_t sourceLength,
    uint8_t* result,
    int32_t resultLength);
C, "icuin.dll");
// $ffi->ucol_getSortKey(coll, source, sourceLength, result, resultLength);
// coll : UCollator*
// source : WORD*
// sourceLength : INT
// result : BYTE* in/out
// resultLength : INT
// 構造体/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_getSortKey(
        LongByReference coll,   // UCollator*
        ShortByReference source,   // WORD*
        int sourceLength,   // INT
        byte[] result,   // BYTE* in/out
        int resultLength   // INT
    );
}
@[Link("icuin")]
lib Libicuin
  fun ucol_getSortKey = ucol_getSortKey(
    coll : LibC::SSizeT*,   # UCollator*
    source : UInt16*,   # WORD*
    sourceLength : Int32,   # INT
    result : UInt8*,   # BYTE* in/out
    resultLength : Int32   # INT
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ucol_getSortKeyNative = Int32 Function(Pointer<IntPtr>, Pointer<Uint16>, Int32, Pointer<Uint8>, Int32);
typedef ucol_getSortKeyDart = int Function(Pointer<IntPtr>, Pointer<Uint16>, int, Pointer<Uint8>, int);
final ucol_getSortKey = DynamicLibrary.open('icuin.dll')
    .lookupFunction<ucol_getSortKeyNative, ucol_getSortKeyDart>('ucol_getSortKey');
// coll : UCollator* -> Pointer<IntPtr>
// source : WORD* -> Pointer<Uint16>
// sourceLength : INT -> Int32
// result : BYTE* in/out -> Pointer<Uint8>
// resultLength : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ucol_getSortKey(
  coll: Pointer;   // UCollator*
  source: Pointer;   // WORD*
  sourceLength: Integer;   // INT
  result: Pointer;   // BYTE* in/out
  resultLength: Integer   // INT
): Integer; cdecl;
  external 'icuin.dll' name 'ucol_getSortKey';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import ccall safe "ucol_getSortKey"
  c_ucol_getSortKey :: Ptr CIntPtr -> Ptr Word16 -> Int32 -> Ptr Word8 -> Int32 -> IO Int32
-- coll : UCollator* -> Ptr CIntPtr
-- source : WORD* -> Ptr Word16
-- sourceLength : INT -> Int32
-- result : BYTE* in/out -> Ptr Word8
-- resultLength : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ucol_getsortkey =
  foreign "ucol_getSortKey"
    ((ptr intptr_t) @-> (ptr uint16_t) @-> int32_t @-> (ptr uint8_t) @-> int32_t @-> returning int32_t)
(* coll : UCollator* -> (ptr intptr_t) *)
(* source : WORD* -> (ptr uint16_t) *)
(* sourceLength : INT -> int32_t *)
(* result : BYTE* in/out -> (ptr uint8_t) *)
(* resultLength : INT -> 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_getSortKey" ucol-get-sort-key :convention :cdecl) :int32
  (coll :pointer)   ; UCollator*
  (source :pointer)   ; WORD*
  (source-length :int32)   ; INT
  (result :pointer)   ; BYTE* in/out
  (result-length :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ucol_getSortKey = Win32::API::More->new('icuin',
    'int ucol_getSortKey(LPVOID coll, LPVOID source, int sourceLength, LPVOID result, int resultLength)');
# my $ret = $ucol_getSortKey->Call($coll, $source, $sourceLength, $result, $resultLength);
# coll : UCollator* -> LPVOID
# source : WORD* -> LPVOID
# sourceLength : INT -> int
# result : BYTE* in/out -> LPVOID
# resultLength : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。