ホーム › NetworkManagement.P2P › DrtCreateIpv6UdpTransport

DrtCreateIpv6UdpTransport

関数

IPv6 UDPによるDRTトランスポートを作成する。

DLLdrttransport.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT DrtCreateIpv6UdpTransport(
    DRT_SCOPE scope,
    DWORD dwScopeId,
    DWORD dwLocalityThreshold,
    WORD* pwPort,
    void** phTransport
);

パラメーター

名前	型	方向	説明
scope	DRT_SCOPE	in	DRT が動作する IPv6 スコープを指定する DRT_SCOPE 列挙型です。
dwScopeId	DWORD	in	スコープが関連付けられているインターフェイスを一意に指定する識別子です。グローバルスコープの場合、このパラメーターは常に "GLOBAL_" ID であり、グローバルスコープのみを使用する場合は省略可能です。リンクローカルスコープの場合、このパラメーターは、リンクローカルスコープが存在するネットワークインターフェイスカードに関連付けられたインターフェイスを表します。
dwLocalityThreshold	DWORD	in	ネイバーをキャッシュする際に、IPv6 アドレスに基づくローカリティ情報をどのように使用するかを指定する識別子です。既定では、DRT はローカルコンピューターと共通のプレフィックスを持つ IPv6 アドレスのネイバーを優先します。
pwPort	WORD*	inout	ローカルの DRT インスタンスが使用するポートへのポインターです。
phTransport	void**	out	DRT_SETTINGS 構造体で指定される DRT トランスポートハンドルへのポインターです。

戻り値の型: HRESULT

公式ドキュメント

DrtCreateIpv6UdpTransport 関数は、IPv6 UDP プロトコルに基づくトランスポートを作成します。

戻り値

この関数は、成功すると S_OK を返します。その他に返される可能性のある値は次のとおりです。

戻り値	説明
E_OUTOFMEMORY	システムがプロバイダー用のメモリを割り当てられません。
DRT_E_INVALID_PORT	pwPort が NULL です。
DRT_E_INVALID_TRANSPORT_PROVIDER	hTransport が NULL です。
DRT_E_INVALID_SCOPE	指定されたスコープが DRT_GLOBAL_SCOPE、DRT_SITE_LOCAL_SCOPE、DRT_LINK_LOCAL_SCOPE のいずれでもありません。
DRT_E_TRANSPORT_UNEXPECTED	予期しないエラーが発生しました。原因については TraceError を参照してください。

注意この関数は、内部で呼び出される NotifyUnicastIpAddressChange、WSAStartup、GetAdaptersAddresses、setsockopt、WSASocket、Bind、WSAIoctl、CreateThreadpoolIo、CreateThreadpoolCleanupGroup、CreateTimerQueue のエラーを返すこともあります。

解説(Remarks)

この関数によって作成される既定の IPv6 UDP トランスポートは、作成対象となった DRT に固有です。そのため、複数の DRT にまたがって再利用することはできません。

Windows XP Service Pack 2 (SP2) で分散ルーティングテーブル API を使用する場合、DrtCreateIpv6UdpTransport によるトランスポートの作成を成功させるには、IPv6 プロトコルのサポートが有効になっている必要があります。

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

各言語での呼び出し定義

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

HRESULT DrtCreateIpv6UdpTransport(
    DRT_SCOPE scope,
    DWORD dwScopeId,
    DWORD dwLocalityThreshold,
    WORD* pwPort,
    void** phTransport
);

[DllImport("drttransport.dll", ExactSpelling = true)]
static extern int DrtCreateIpv6UdpTransport(
    int scope,   // DRT_SCOPE
    uint dwScopeId,   // DWORD
    uint dwLocalityThreshold,   // DWORD
    ref ushort pwPort,   // WORD* in/out
    IntPtr phTransport   // void** out
);

<DllImport("drttransport.dll", ExactSpelling:=True)>
Public Shared Function DrtCreateIpv6UdpTransport(
    scope As Integer,   ' DRT_SCOPE
    dwScopeId As UInteger,   ' DWORD
    dwLocalityThreshold As UInteger,   ' DWORD
    ByRef pwPort As UShort,   ' WORD* in/out
    phTransport As IntPtr   ' void** out
) As Integer
End Function

' scope : DRT_SCOPE
' dwScopeId : DWORD
' dwLocalityThreshold : DWORD
' pwPort : WORD* in/out
' phTransport : void** out
Declare PtrSafe Function DrtCreateIpv6UdpTransport Lib "drttransport" ( _
    ByVal scope As Long, _
    ByVal dwScopeId As Long, _
    ByVal dwLocalityThreshold As Long, _
    ByRef pwPort As Integer, _
    ByVal phTransport As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DrtCreateIpv6UdpTransport = ctypes.windll.drttransport.DrtCreateIpv6UdpTransport
DrtCreateIpv6UdpTransport.restype = ctypes.c_int
DrtCreateIpv6UdpTransport.argtypes = [
    ctypes.c_int,  # scope : DRT_SCOPE
    wintypes.DWORD,  # dwScopeId : DWORD
    wintypes.DWORD,  # dwLocalityThreshold : DWORD
    ctypes.POINTER(ctypes.c_ushort),  # pwPort : WORD* in/out
    ctypes.c_void_p,  # phTransport : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('drttransport.dll')
DrtCreateIpv6UdpTransport = Fiddle::Function.new(
  lib['DrtCreateIpv6UdpTransport'],
  [
    Fiddle::TYPE_INT,  # scope : DRT_SCOPE
    -Fiddle::TYPE_INT,  # dwScopeId : DWORD
    -Fiddle::TYPE_INT,  # dwLocalityThreshold : DWORD
    Fiddle::TYPE_VOIDP,  # pwPort : WORD* in/out
    Fiddle::TYPE_VOIDP,  # phTransport : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "drttransport")]
extern "system" {
    fn DrtCreateIpv6UdpTransport(
        scope: i32,  // DRT_SCOPE
        dwScopeId: u32,  // DWORD
        dwLocalityThreshold: u32,  // DWORD
        pwPort: *mut u16,  // WORD* in/out
        phTransport: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("drttransport.dll")]
public static extern int DrtCreateIpv6UdpTransport(int scope, uint dwScopeId, uint dwLocalityThreshold, ref ushort pwPort, IntPtr phTransport);
"@
$api = Add-Type -MemberDefinition $sig -Name 'drttransport_DrtCreateIpv6UdpTransport' -Namespace Win32 -PassThru
# $api::DrtCreateIpv6UdpTransport(scope, dwScopeId, dwLocalityThreshold, pwPort, phTransport)

#uselib "drttransport.dll"
#func global DrtCreateIpv6UdpTransport "DrtCreateIpv6UdpTransport" sptr, sptr, sptr, sptr, sptr
; DrtCreateIpv6UdpTransport scope, dwScopeId, dwLocalityThreshold, varptr(pwPort), phTransport   ; 戻り値は stat
; scope : DRT_SCOPE -> "sptr"
; dwScopeId : DWORD -> "sptr"
; dwLocalityThreshold : DWORD -> "sptr"
; pwPort : WORD* in/out -> "sptr"
; phTransport : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "drttransport.dll"
#cfunc global DrtCreateIpv6UdpTransport "DrtCreateIpv6UdpTransport" int, int, int, var, sptr
; res = DrtCreateIpv6UdpTransport(scope, dwScopeId, dwLocalityThreshold, pwPort, phTransport)
; scope : DRT_SCOPE -> "int"
; dwScopeId : DWORD -> "int"
; dwLocalityThreshold : DWORD -> "int"
; pwPort : WORD* in/out -> "var"
; phTransport : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "drttransport.dll"
#cfunc global DrtCreateIpv6UdpTransport "DrtCreateIpv6UdpTransport" int, int, int, sptr, sptr
; res = DrtCreateIpv6UdpTransport(scope, dwScopeId, dwLocalityThreshold, varptr(pwPort), phTransport)
; scope : DRT_SCOPE -> "int"
; dwScopeId : DWORD -> "int"
; dwLocalityThreshold : DWORD -> "int"
; pwPort : WORD* in/out -> "sptr"
; phTransport : void** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。