Win32 API 日本語リファレンス
ホーム › NetworkManagement.IpHelper › CreateSortedAddressPairs

CreateSortedAddressPairs

関数
送信元と宛先のアドレス対を優先順位で並べ替えて作成する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

WIN32_ERROR CreateSortedAddressPairs(
    const SOCKADDR_IN6* SourceAddressList,   // optional
    DWORD SourceAddressCount,
    const SOCKADDR_IN6* DestinationAddressList,
    DWORD DestinationAddressCount,
    DWORD AddressSortOptions,
    SOCKADDR_IN6_PAIR** SortedAddressPairList,
    DWORD* SortedAddressPairCount
);

パラメーター

名前型方向説明
SourceAddressListSOCKADDR_IN6*inoptionalNULL である必要があります。将来の使用のために予約されています。
SourceAddressCountDWORDin0 である必要があります。将来の使用のために予約されています。
DestinationAddressListSOCKADDR_IN6*inIPv6 宛先アドレスの候補リストを格納した SOCKADDR_IN6 構造体の配列へのポインターです。 IPv4 アドレスは、IPv6 専用アプリケーションが IPv4 ノードと通信できるようにする IPv4-mapped IPv6 アドレス形式で表現する必要があります。
DestinationAddressCountDWORDinDestinationAddressList パラメーターが指す宛先アドレスの数です。
AddressSortOptionsDWORDin将来の使用のために予約されています。
SortedAddressPairListSOCKADDR_IN6_PAIR**out関数呼び出しが成功した場合に、通信の優先順位でソートされた IPv6 アドレスのペアのリストを格納する SOCKADDR_IN6_PAIR 構造体の配列を格納するためのポインターです。
SortedAddressPairCountDWORD*out関数呼び出しが成功した場合に、SortedAddressPairList パラメーターが指すアドレスペアの数を格納するためのポインターです。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定された IP 宛先アドレスの候補リストを受け取り、それらの宛先アドレスをホストマシンのローカル IP アドレスとペアにし、2 つのピア間の通信に最も適したアドレスペアの順序でソートします。

戻り値

関数が成功した場合、戻り値は NO_ERROR です。

関数が失敗した場合、戻り値は次のいずれかのエラーコードです。

戻りコード 説明
ERROR_INVALID_PARAMETER
 無効なパラメーターが関数に渡されました。このエラーは、DestinationAddressList、SortedAddressPairList、または SortedAddressPairCount パラメーターが NULL の場合、あるいは DestinationAddressCount が 500 より大きい場合に返されます。また、SourceAddressList が NULL でない場合、または SourceAddressPairCount パラメーターが 0 でない場合にも返されます。
ERROR_NOT_ENOUGH_MEMORY
 このコマンドを処理するのに十分なストレージがありません。
ERROR_NOT_SUPPORTED
 要求はサポートされていません。このエラーは、ローカルコンピューターに IPv6 スタックが存在しない場合に返されます。
その他
 返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用してください。

解説(Remarks)

CreateSortedAddressPairs 関数は Windows Vista 以降で定義されています。

CreateSortedAddressPairs 関数は、送信元および宛先の IPv6 アドレスのリストを受け取り、ソートされた順序でアドレスのペアのリストを返します。リストは、送信元アドレスと宛先アドレス間の通信に最も適したアドレスペアの順序でソートされます。

SourceAddressList が指す送信元アドレスのリストは現在将来の使用のために予約されており、NULL ポインターである必要があります。SourceAddressCount は現在将来の使用のために予約されており、0 である必要があります。CreateSortedAddressPairs 関数は現在、送信元アドレスリストとしてホストマシンのすべてのローカルアドレスを使用します。

宛先アドレスのリストは DestinationAddressList パラメーターによって指されます。宛先アドレスのリストは SOCKADDR_IN6 構造体の配列です。IPv4 アドレスは、IPv6 専用アプリケーションが IPv4 ノードと通信できるようにする IPv4-mapped IPv6 アドレス形式で表現する必要があります。IPv4-mapped IPv6 アドレス形式の詳細については、Dual-Stack Sockets を参照してください。DestinationAddressCount パラメーターには、DestinationAddressList パラメーターが指す宛先アドレスの数が格納されます。CreateSortedAddressPairs 関数は最大 500 個の宛先アドレスをサポートします。

CreateSortedAddressPairs 関数が成功した場合、SortedAddressPairList パラメーターは、ソートされたアドレスペアを格納した SOCKADDR_IN6_PAIR 構造体の配列を指します。返されたこのリストが不要になったら、FreeMibTable 関数を呼び出してリストが使用するメモリを解放してください。

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

各言語での呼び出し定義

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

WIN32_ERROR CreateSortedAddressPairs(
    const SOCKADDR_IN6* SourceAddressList,   // optional
    DWORD SourceAddressCount,
    const SOCKADDR_IN6* DestinationAddressList,
    DWORD DestinationAddressCount,
    DWORD AddressSortOptions,
    SOCKADDR_IN6_PAIR** SortedAddressPairList,
    DWORD* SortedAddressPairCount
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint CreateSortedAddressPairs(
    IntPtr SourceAddressList,   // SOCKADDR_IN6* optional
    uint SourceAddressCount,   // DWORD
    IntPtr DestinationAddressList,   // SOCKADDR_IN6*
    uint DestinationAddressCount,   // DWORD
    uint AddressSortOptions,   // DWORD
    IntPtr SortedAddressPairList,   // SOCKADDR_IN6_PAIR** out
    out uint SortedAddressPairCount   // DWORD* out
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function CreateSortedAddressPairs(
    SourceAddressList As IntPtr,   ' SOCKADDR_IN6* optional
    SourceAddressCount As UInteger,   ' DWORD
    DestinationAddressList As IntPtr,   ' SOCKADDR_IN6*
    DestinationAddressCount As UInteger,   ' DWORD
    AddressSortOptions As UInteger,   ' DWORD
    SortedAddressPairList As IntPtr,   ' SOCKADDR_IN6_PAIR** out
    <Out> ByRef SortedAddressPairCount As UInteger   ' DWORD* out
) As UInteger
End Function
' SourceAddressList : SOCKADDR_IN6* optional
' SourceAddressCount : DWORD
' DestinationAddressList : SOCKADDR_IN6*
' DestinationAddressCount : DWORD
' AddressSortOptions : DWORD
' SortedAddressPairList : SOCKADDR_IN6_PAIR** out
' SortedAddressPairCount : DWORD* out
Declare PtrSafe Function CreateSortedAddressPairs Lib "iphlpapi" ( _
    ByVal SourceAddressList As LongPtr, _
    ByVal SourceAddressCount As Long, _
    ByVal DestinationAddressList As LongPtr, _
    ByVal DestinationAddressCount As Long, _
    ByVal AddressSortOptions As Long, _
    ByVal SortedAddressPairList As LongPtr, _
    ByRef SortedAddressPairCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CreateSortedAddressPairs = ctypes.windll.iphlpapi.CreateSortedAddressPairs
CreateSortedAddressPairs.restype = wintypes.DWORD
CreateSortedAddressPairs.argtypes = [
    ctypes.c_void_p,  # SourceAddressList : SOCKADDR_IN6* optional
    wintypes.DWORD,  # SourceAddressCount : DWORD
    ctypes.c_void_p,  # DestinationAddressList : SOCKADDR_IN6*
    wintypes.DWORD,  # DestinationAddressCount : DWORD
    wintypes.DWORD,  # AddressSortOptions : DWORD
    ctypes.c_void_p,  # SortedAddressPairList : SOCKADDR_IN6_PAIR** out
    ctypes.POINTER(wintypes.DWORD),  # SortedAddressPairCount : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
CreateSortedAddressPairs = Fiddle::Function.new(
  lib['CreateSortedAddressPairs'],
  [
    Fiddle::TYPE_VOIDP,  # SourceAddressList : SOCKADDR_IN6* optional
    -Fiddle::TYPE_INT,  # SourceAddressCount : DWORD
    Fiddle::TYPE_VOIDP,  # DestinationAddressList : SOCKADDR_IN6*
    -Fiddle::TYPE_INT,  # DestinationAddressCount : DWORD
    -Fiddle::TYPE_INT,  # AddressSortOptions : DWORD
    Fiddle::TYPE_VOIDP,  # SortedAddressPairList : SOCKADDR_IN6_PAIR** out
    Fiddle::TYPE_VOIDP,  # SortedAddressPairCount : DWORD* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "iphlpapi")]
extern "system" {
    fn CreateSortedAddressPairs(
        SourceAddressList: *const SOCKADDR_IN6,  // SOCKADDR_IN6* optional
        SourceAddressCount: u32,  // DWORD
        DestinationAddressList: *const SOCKADDR_IN6,  // SOCKADDR_IN6*
        DestinationAddressCount: u32,  // DWORD
        AddressSortOptions: u32,  // DWORD
        SortedAddressPairList: *mut *mut SOCKADDR_IN6_PAIR,  // SOCKADDR_IN6_PAIR** out
        SortedAddressPairCount: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint CreateSortedAddressPairs(IntPtr SourceAddressList, uint SourceAddressCount, IntPtr DestinationAddressList, uint DestinationAddressCount, uint AddressSortOptions, IntPtr SortedAddressPairList, out uint SortedAddressPairCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_CreateSortedAddressPairs' -Namespace Win32 -PassThru
# $api::CreateSortedAddressPairs(SourceAddressList, SourceAddressCount, DestinationAddressList, DestinationAddressCount, AddressSortOptions, SortedAddressPairList, SortedAddressPairCount)
#uselib "IPHLPAPI.dll"
#func global CreateSortedAddressPairs "CreateSortedAddressPairs" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; CreateSortedAddressPairs varptr(SourceAddressList), SourceAddressCount, varptr(DestinationAddressList), DestinationAddressCount, AddressSortOptions, varptr(SortedAddressPairList), varptr(SortedAddressPairCount)   ; 戻り値は stat
; SourceAddressList : SOCKADDR_IN6* optional -> "sptr"
; SourceAddressCount : DWORD -> "sptr"
; DestinationAddressList : SOCKADDR_IN6* -> "sptr"
; DestinationAddressCount : DWORD -> "sptr"
; AddressSortOptions : DWORD -> "sptr"
; SortedAddressPairList : SOCKADDR_IN6_PAIR** out -> "sptr"
; SortedAddressPairCount : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "IPHLPAPI.dll"
#cfunc global CreateSortedAddressPairs "CreateSortedAddressPairs" var, int, var, int, int, var, var
; res = CreateSortedAddressPairs(SourceAddressList, SourceAddressCount, DestinationAddressList, DestinationAddressCount, AddressSortOptions, SortedAddressPairList, SortedAddressPairCount)
; SourceAddressList : SOCKADDR_IN6* optional -> "var"
; SourceAddressCount : DWORD -> "int"
; DestinationAddressList : SOCKADDR_IN6* -> "var"
; DestinationAddressCount : DWORD -> "int"
; AddressSortOptions : DWORD -> "int"
; SortedAddressPairList : SOCKADDR_IN6_PAIR** out -> "var"
; SortedAddressPairCount : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; WIN32_ERROR CreateSortedAddressPairs(SOCKADDR_IN6* SourceAddressList, DWORD SourceAddressCount, SOCKADDR_IN6* DestinationAddressList, DWORD DestinationAddressCount, DWORD AddressSortOptions, SOCKADDR_IN6_PAIR** SortedAddressPairList, DWORD* SortedAddressPairCount)
#uselib "IPHLPAPI.dll"
#cfunc global CreateSortedAddressPairs "CreateSortedAddressPairs" var, int, var, int, int, var, var
; res = CreateSortedAddressPairs(SourceAddressList, SourceAddressCount, DestinationAddressList, DestinationAddressCount, AddressSortOptions, SortedAddressPairList, SortedAddressPairCount)
; SourceAddressList : SOCKADDR_IN6* optional -> "var"
; SourceAddressCount : DWORD -> "int"
; DestinationAddressList : SOCKADDR_IN6* -> "var"
; DestinationAddressCount : DWORD -> "int"
; AddressSortOptions : DWORD -> "int"
; SortedAddressPairList : SOCKADDR_IN6_PAIR** out -> "var"
; SortedAddressPairCount : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procCreateSortedAddressPairs = iphlpapi.NewProc("CreateSortedAddressPairs")
)

// SourceAddressList (SOCKADDR_IN6* optional), SourceAddressCount (DWORD), DestinationAddressList (SOCKADDR_IN6*), DestinationAddressCount (DWORD), AddressSortOptions (DWORD), SortedAddressPairList (SOCKADDR_IN6_PAIR** out), SortedAddressPairCount (DWORD* out)
r1, _, err := procCreateSortedAddressPairs.Call(
	uintptr(SourceAddressList),
	uintptr(SourceAddressCount),
	uintptr(DestinationAddressList),
	uintptr(DestinationAddressCount),
	uintptr(AddressSortOptions),
	uintptr(SortedAddressPairList),
	uintptr(SortedAddressPairCount),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function CreateSortedAddressPairs(
  SourceAddressList: Pointer;   // SOCKADDR_IN6* optional
  SourceAddressCount: DWORD;   // DWORD
  DestinationAddressList: Pointer;   // SOCKADDR_IN6*
  DestinationAddressCount: DWORD;   // DWORD
  AddressSortOptions: DWORD;   // DWORD
  SortedAddressPairList: Pointer;   // SOCKADDR_IN6_PAIR** out
  SortedAddressPairCount: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'CreateSortedAddressPairs';
result := DllCall("IPHLPAPI\CreateSortedAddressPairs"
    , "Ptr", SourceAddressList   ; SOCKADDR_IN6* optional
    , "UInt", SourceAddressCount   ; DWORD
    , "Ptr", DestinationAddressList   ; SOCKADDR_IN6*
    , "UInt", DestinationAddressCount   ; DWORD
    , "UInt", AddressSortOptions   ; DWORD
    , "Ptr", SortedAddressPairList   ; SOCKADDR_IN6_PAIR** out
    , "Ptr", SortedAddressPairCount   ; DWORD* out
    , "UInt")   ; return: WIN32_ERROR
●CreateSortedAddressPairs(SourceAddressList, SourceAddressCount, DestinationAddressList, DestinationAddressCount, AddressSortOptions, SortedAddressPairList, SortedAddressPairCount) = DLL("IPHLPAPI.dll", "dword CreateSortedAddressPairs(void*, dword, void*, dword, dword, void*, void*)")
# 呼び出し: CreateSortedAddressPairs(SourceAddressList, SourceAddressCount, DestinationAddressList, DestinationAddressCount, AddressSortOptions, SortedAddressPairList, SortedAddressPairCount)
# SourceAddressList : SOCKADDR_IN6* optional -> "void*"
# SourceAddressCount : DWORD -> "dword"
# DestinationAddressList : SOCKADDR_IN6* -> "void*"
# DestinationAddressCount : DWORD -> "dword"
# AddressSortOptions : DWORD -> "dword"
# SortedAddressPairList : SOCKADDR_IN6_PAIR** out -> "void*"
# SortedAddressPairCount : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "iphlpapi" fn CreateSortedAddressPairs(
    SourceAddressList: [*c]SOCKADDR_IN6, // SOCKADDR_IN6* optional
    SourceAddressCount: u32, // DWORD
    DestinationAddressList: [*c]SOCKADDR_IN6, // SOCKADDR_IN6*
    DestinationAddressCount: u32, // DWORD
    AddressSortOptions: u32, // DWORD
    SortedAddressPairList: [*c][*c]SOCKADDR_IN6_PAIR, // SOCKADDR_IN6_PAIR** out
    SortedAddressPairCount: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) u32;
proc CreateSortedAddressPairs(
    SourceAddressList: ptr SOCKADDR_IN6,  # SOCKADDR_IN6* optional
    SourceAddressCount: uint32,  # DWORD
    DestinationAddressList: ptr SOCKADDR_IN6,  # SOCKADDR_IN6*
    DestinationAddressCount: uint32,  # DWORD
    AddressSortOptions: uint32,  # DWORD
    SortedAddressPairList: ptr SOCKADDR_IN6_PAIR,  # SOCKADDR_IN6_PAIR** out
    SortedAddressPairCount: ptr uint32  # DWORD* out
): uint32 {.importc: "CreateSortedAddressPairs", stdcall, dynlib: "IPHLPAPI.dll".}
pragma(lib, "iphlpapi");
extern(Windows)
uint CreateSortedAddressPairs(
    SOCKADDR_IN6* SourceAddressList,   // SOCKADDR_IN6* optional
    uint SourceAddressCount,   // DWORD
    SOCKADDR_IN6* DestinationAddressList,   // SOCKADDR_IN6*
    uint DestinationAddressCount,   // DWORD
    uint AddressSortOptions,   // DWORD
    SOCKADDR_IN6_PAIR** SortedAddressPairList,   // SOCKADDR_IN6_PAIR** out
    uint* SortedAddressPairCount   // DWORD* out
);
ccall((:CreateSortedAddressPairs, "IPHLPAPI.dll"), stdcall, UInt32,
      (Ptr{SOCKADDR_IN6}, UInt32, Ptr{SOCKADDR_IN6}, UInt32, UInt32, Ptr{SOCKADDR_IN6_PAIR}, Ptr{UInt32}),
      SourceAddressList, SourceAddressCount, DestinationAddressList, DestinationAddressCount, AddressSortOptions, SortedAddressPairList, SortedAddressPairCount)
# SourceAddressList : SOCKADDR_IN6* optional -> Ptr{SOCKADDR_IN6}
# SourceAddressCount : DWORD -> UInt32
# DestinationAddressList : SOCKADDR_IN6* -> Ptr{SOCKADDR_IN6}
# DestinationAddressCount : DWORD -> UInt32
# AddressSortOptions : DWORD -> UInt32
# SortedAddressPairList : SOCKADDR_IN6_PAIR** out -> Ptr{SOCKADDR_IN6_PAIR}
# SortedAddressPairCount : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t CreateSortedAddressPairs(
    void* SourceAddressList,
    uint32_t SourceAddressCount,
    void* DestinationAddressList,
    uint32_t DestinationAddressCount,
    uint32_t AddressSortOptions,
    void* SortedAddressPairList,
    uint32_t* SortedAddressPairCount);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.CreateSortedAddressPairs(SourceAddressList, SourceAddressCount, DestinationAddressList, DestinationAddressCount, AddressSortOptions, SortedAddressPairList, SortedAddressPairCount)
-- SourceAddressList : SOCKADDR_IN6* optional
-- SourceAddressCount : DWORD
-- DestinationAddressList : SOCKADDR_IN6*
-- DestinationAddressCount : DWORD
-- AddressSortOptions : DWORD
-- SortedAddressPairList : SOCKADDR_IN6_PAIR** out
-- SortedAddressPairCount : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const CreateSortedAddressPairs = lib.func('__stdcall', 'CreateSortedAddressPairs', 'uint32_t', ['void *', 'uint32_t', 'void *', 'uint32_t', 'uint32_t', 'void *', 'uint32_t *']);
// CreateSortedAddressPairs(SourceAddressList, SourceAddressCount, DestinationAddressList, DestinationAddressCount, AddressSortOptions, SortedAddressPairList, SortedAddressPairCount)
// SourceAddressList : SOCKADDR_IN6* optional -> 'void *'
// SourceAddressCount : DWORD -> 'uint32_t'
// DestinationAddressList : SOCKADDR_IN6* -> 'void *'
// DestinationAddressCount : DWORD -> 'uint32_t'
// AddressSortOptions : DWORD -> 'uint32_t'
// SortedAddressPairList : SOCKADDR_IN6_PAIR** out -> 'void *'
// SortedAddressPairCount : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IPHLPAPI.dll", {
  CreateSortedAddressPairs: { parameters: ["pointer", "u32", "pointer", "u32", "u32", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.CreateSortedAddressPairs(SourceAddressList, SourceAddressCount, DestinationAddressList, DestinationAddressCount, AddressSortOptions, SortedAddressPairList, SortedAddressPairCount)
// SourceAddressList : SOCKADDR_IN6* optional -> "pointer"
// SourceAddressCount : DWORD -> "u32"
// DestinationAddressList : SOCKADDR_IN6* -> "pointer"
// DestinationAddressCount : DWORD -> "u32"
// AddressSortOptions : DWORD -> "u32"
// SortedAddressPairList : SOCKADDR_IN6_PAIR** out -> "pointer"
// SortedAddressPairCount : DWORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t CreateSortedAddressPairs(
    void* SourceAddressList,
    uint32_t SourceAddressCount,
    void* DestinationAddressList,
    uint32_t DestinationAddressCount,
    uint32_t AddressSortOptions,
    void* SortedAddressPairList,
    uint32_t* SortedAddressPairCount);
C, "IPHLPAPI.dll");
// $ffi->CreateSortedAddressPairs(SourceAddressList, SourceAddressCount, DestinationAddressList, DestinationAddressCount, AddressSortOptions, SortedAddressPairList, SortedAddressPairCount);
// SourceAddressList : SOCKADDR_IN6* optional
// SourceAddressCount : DWORD
// DestinationAddressList : SOCKADDR_IN6*
// DestinationAddressCount : DWORD
// AddressSortOptions : DWORD
// SortedAddressPairList : SOCKADDR_IN6_PAIR** out
// SortedAddressPairCount : DWORD* out
// 構造体/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 Iphlpapi extends StdCallLibrary {
    Iphlpapi INSTANCE = Native.load("iphlpapi", Iphlpapi.class);
    int CreateSortedAddressPairs(
        Pointer SourceAddressList,   // SOCKADDR_IN6* optional
        int SourceAddressCount,   // DWORD
        Pointer DestinationAddressList,   // SOCKADDR_IN6*
        int DestinationAddressCount,   // DWORD
        int AddressSortOptions,   // DWORD
        Pointer SortedAddressPairList,   // SOCKADDR_IN6_PAIR** out
        IntByReference SortedAddressPairCount   // DWORD* out
    );
}
@[Link("iphlpapi")]
lib LibIPHLPAPI
  fun CreateSortedAddressPairs = CreateSortedAddressPairs(
    SourceAddressList : SOCKADDR_IN6*,   # SOCKADDR_IN6* optional
    SourceAddressCount : UInt32,   # DWORD
    DestinationAddressList : SOCKADDR_IN6*,   # SOCKADDR_IN6*
    DestinationAddressCount : UInt32,   # DWORD
    AddressSortOptions : UInt32,   # DWORD
    SortedAddressPairList : SOCKADDR_IN6_PAIR**,   # SOCKADDR_IN6_PAIR** out
    SortedAddressPairCount : UInt32*   # DWORD* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CreateSortedAddressPairsNative = Uint32 Function(Pointer<Void>, Uint32, Pointer<Void>, Uint32, Uint32, Pointer<Void>, Pointer<Uint32>);
typedef CreateSortedAddressPairsDart = int Function(Pointer<Void>, int, Pointer<Void>, int, int, Pointer<Void>, Pointer<Uint32>);
final CreateSortedAddressPairs = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<CreateSortedAddressPairsNative, CreateSortedAddressPairsDart>('CreateSortedAddressPairs');
// SourceAddressList : SOCKADDR_IN6* optional -> Pointer<Void>
// SourceAddressCount : DWORD -> Uint32
// DestinationAddressList : SOCKADDR_IN6* -> Pointer<Void>
// DestinationAddressCount : DWORD -> Uint32
// AddressSortOptions : DWORD -> Uint32
// SortedAddressPairList : SOCKADDR_IN6_PAIR** out -> Pointer<Void>
// SortedAddressPairCount : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateSortedAddressPairs(
  SourceAddressList: Pointer;   // SOCKADDR_IN6* optional
  SourceAddressCount: DWORD;   // DWORD
  DestinationAddressList: Pointer;   // SOCKADDR_IN6*
  DestinationAddressCount: DWORD;   // DWORD
  AddressSortOptions: DWORD;   // DWORD
  SortedAddressPairList: Pointer;   // SOCKADDR_IN6_PAIR** out
  SortedAddressPairCount: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'CreateSortedAddressPairs';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CreateSortedAddressPairs"
  c_CreateSortedAddressPairs :: Ptr () -> Word32 -> Ptr () -> Word32 -> Word32 -> Ptr () -> Ptr Word32 -> IO Word32
-- SourceAddressList : SOCKADDR_IN6* optional -> Ptr ()
-- SourceAddressCount : DWORD -> Word32
-- DestinationAddressList : SOCKADDR_IN6* -> Ptr ()
-- DestinationAddressCount : DWORD -> Word32
-- AddressSortOptions : DWORD -> Word32
-- SortedAddressPairList : SOCKADDR_IN6_PAIR** out -> Ptr ()
-- SortedAddressPairCount : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let createsortedaddresspairs =
  foreign "CreateSortedAddressPairs"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> uint32_t @-> uint32_t @-> (ptr void) @-> (ptr uint32_t) @-> returning uint32_t)
(* SourceAddressList : SOCKADDR_IN6* optional -> (ptr void) *)
(* SourceAddressCount : DWORD -> uint32_t *)
(* DestinationAddressList : SOCKADDR_IN6* -> (ptr void) *)
(* DestinationAddressCount : DWORD -> uint32_t *)
(* AddressSortOptions : DWORD -> uint32_t *)
(* SortedAddressPairList : SOCKADDR_IN6_PAIR** out -> (ptr void) *)
(* SortedAddressPairCount : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)

(cffi:defcfun ("CreateSortedAddressPairs" create-sorted-address-pairs :convention :stdcall) :uint32
  (source-address-list :pointer)   ; SOCKADDR_IN6* optional
  (source-address-count :uint32)   ; DWORD
  (destination-address-list :pointer)   ; SOCKADDR_IN6*
  (destination-address-count :uint32)   ; DWORD
  (address-sort-options :uint32)   ; DWORD
  (sorted-address-pair-list :pointer)   ; SOCKADDR_IN6_PAIR** out
  (sorted-address-pair-count :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateSortedAddressPairs = Win32::API::More->new('IPHLPAPI',
    'DWORD CreateSortedAddressPairs(LPVOID SourceAddressList, DWORD SourceAddressCount, LPVOID DestinationAddressList, DWORD DestinationAddressCount, DWORD AddressSortOptions, LPVOID SortedAddressPairList, LPVOID SortedAddressPairCount)');
# my $ret = $CreateSortedAddressPairs->Call($SourceAddressList, $SourceAddressCount, $DestinationAddressList, $DestinationAddressCount, $AddressSortOptions, $SortedAddressPairList, $SortedAddressPairCount);
# SourceAddressList : SOCKADDR_IN6* optional -> LPVOID
# SourceAddressCount : DWORD -> DWORD
# DestinationAddressList : SOCKADDR_IN6* -> LPVOID
# DestinationAddressCount : DWORD -> DWORD
# AddressSortOptions : DWORD -> DWORD
# SortedAddressPairList : SOCKADDR_IN6_PAIR** out -> LPVOID
# SortedAddressPairCount : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型