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

CreateSortedAddressPairs

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

シグネチャ

// 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*inoptional
SourceAddressCountDWORDin
DestinationAddressListSOCKADDR_IN6*in
DestinationAddressCountDWORDin
AddressSortOptionsDWORDin
SortedAddressPairListSOCKADDR_IN6_PAIR**out
SortedAddressPairCountDWORD*out

戻り値の型: WIN32_ERROR

各言語での呼び出し定義

// 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)。