DrtOpen

関数

指定設定で分散ルーティングテーブルを開く。

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

シグネチャ

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

HRESULT DrtOpen(
    const DRT_SETTINGS* pSettings,
    HANDLE hEvent,   // optional
    const void* pvContext,   // optional
    void** phDrt
);

パラメーター

名前	型	方向	説明
pSettings	DRT_SETTINGS*	in	DRT インスタンスの作成に使用する設定を指定する DRT_SETTINGS 構造体へのポインターです。
hEvent	HANDLE	inoptional	イベントが発生したときにシグナル状態になるイベントのハンドルです。
pvContext	void*	inoptional	イベントを介してアプリケーションに渡される、ユーザー定義のコンテキストデータです。
phDrt	void**	out	DRT に関連付けられる新しいハンドルです。これは、以降の DRT インスタンスに対するすべての操作で使用されます。

戻り値の型: HRESULT

公式ドキュメント

DrtOpen 関数は、DRT_SETTINGS 構造体で指定された条件に従って、ローカルの分散ルーティングテーブル (Distributed Routing Table) インスタンスを作成します。

戻り値

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

戻り値	説明
E_INVALIDARG	phDrt が NULL です。
DRT_E_INVALID_SETTINGS	pSettings が NULL であるか、DRT_SETTINGS の dwSize メンバーの値が DRT_SETTINGS オブジェクトのサイズと一致しません。
DRT_E_INVALID_KEY_SIZE	cbKey が 256 ビットではありません。
DRT_E_INVALID_MAX_ADDRESSES	DRT_SETTINGS の ulMaxRoutingAddresses メンバーで、アドレスの最大数として 1 未満または 20 を超える値が指定されています。
DRT_E_INVALID_TRANSPORT_PROVIDER	DRT_SETTINGS の hTransport メンバーが NULL であるか、Transport の一部のフィールドが NULL です
DRT_E_INVALID_SECURITY_MODE	DRT_SETTINGS の eSecurityMode メンバーで無効なセキュリティモードが指定されています。
DRT_E_INVALID_SECURITY_PROVIDER	DRT_SETTINGS の pSecurityProvider メンバーが NULL です。
DRT_E_INVALID_BOOTSTRAP_PROVIDER	DRT_SETTINGS の pBootstrapProvider メンバーが NULL であるか、ブートストラッププロバイダーの一部のフィールドが NULL です。
DRT_E_INVALID_INSTANCE_PREFIX	DRT_SETTINGS で指定された pwzDrtInstancePrefix のサイズが、プレフィックスの最大長 (128) を超えています。
E_OUTOFMEMORY	システムはこの操作のためのメモリを割り当てることができません。
DRT_E_BOOTSTRAPPROVIDER_IN_USE	ブートストラッププロバイダーは既にアタッチされています。
DRT_E_SECURITYPROVIDER_IN_USE	セキュリティプロバイダーは既にアタッチされています。
DRT_TRANSPORTPROVIDER_IN_USE	トランスポートプロバイダーは既にアタッチされています。
DRT_E_INVALID_CERT_CHAIN	証明書チェーンが無効です。
DRT_E_CAPABILITY_MISMATCH	DRT_SECURE_MEMBERSHIP および DRT_SECURE_CONFIDENTIALPAYLOAD のセキュリティでは、ローカル証明書を NULL にすることはできません。
DRT_E_TRANSPORT_SHUTTING_DOWN	トランスポートはシャットダウン中です。
DRT_E_TRANSPORT_ALREADY_BOUND	トランスポートは既にバインドされています。
DRT_S_RETRY	ブートストラッププロバイダーは他のノードを検出できませんでしたが、再試行すると成功する可能性があります。
DRT_E_TRANSPORT_INVALID_ARGUMENT	トランスポートプロバイダーのパラメーターが NULL または無効です。
DRT_E_TRANSPORTPROVIDER_NOT_ATTACHED	トランスポートはアタッチされていません。
E_FAIL	予期しない致命的なエラーが発生しました。

解説(Remarks)

DrtOpen が呼び出されると、DRT はブートストラップ処理を開始し、ブートストラップの成否に応じて DRT_ACTIVE 状態または DRT_ALONE 状態に移行します。

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

各言語での呼び出し定義

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

HRESULT DrtOpen(
    const DRT_SETTINGS* pSettings,
    HANDLE hEvent,   // optional
    const void* pvContext,   // optional
    void** phDrt
);

[DllImport("drt.dll", ExactSpelling = true)]
static extern int DrtOpen(
    IntPtr pSettings,   // DRT_SETTINGS*
    IntPtr hEvent,   // HANDLE optional
    IntPtr pvContext,   // void* optional
    IntPtr phDrt   // void** out
);

<DllImport("drt.dll", ExactSpelling:=True)>
Public Shared Function DrtOpen(
    pSettings As IntPtr,   ' DRT_SETTINGS*
    hEvent As IntPtr,   ' HANDLE optional
    pvContext As IntPtr,   ' void* optional
    phDrt As IntPtr   ' void** out
) As Integer
End Function

' pSettings : DRT_SETTINGS*
' hEvent : HANDLE optional
' pvContext : void* optional
' phDrt : void** out
Declare PtrSafe Function DrtOpen Lib "drt" ( _
    ByVal pSettings As LongPtr, _
    ByVal hEvent As LongPtr, _
    ByVal pvContext As LongPtr, _
    ByVal phDrt As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DrtOpen = ctypes.windll.drt.DrtOpen
DrtOpen.restype = ctypes.c_int
DrtOpen.argtypes = [
    ctypes.c_void_p,  # pSettings : DRT_SETTINGS*
    wintypes.HANDLE,  # hEvent : HANDLE optional
    ctypes.POINTER(None),  # pvContext : void* optional
    ctypes.c_void_p,  # phDrt : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('drt.dll')
DrtOpen = Fiddle::Function.new(
  lib['DrtOpen'],
  [
    Fiddle::TYPE_VOIDP,  # pSettings : DRT_SETTINGS*
    Fiddle::TYPE_VOIDP,  # hEvent : HANDLE optional
    Fiddle::TYPE_VOIDP,  # pvContext : void* optional
    Fiddle::TYPE_VOIDP,  # phDrt : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "drt")]
extern "system" {
    fn DrtOpen(
        pSettings: *const DRT_SETTINGS,  // DRT_SETTINGS*
        hEvent: *mut core::ffi::c_void,  // HANDLE optional
        pvContext: *const (),  // void* optional
        phDrt: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("drt.dll")]
public static extern int DrtOpen(IntPtr pSettings, IntPtr hEvent, IntPtr pvContext, IntPtr phDrt);
"@
$api = Add-Type -MemberDefinition $sig -Name 'drt_DrtOpen' -Namespace Win32 -PassThru
# $api::DrtOpen(pSettings, hEvent, pvContext, phDrt)

#uselib "drt.dll"
#func global DrtOpen "DrtOpen" sptr, sptr, sptr, sptr
; DrtOpen varptr(pSettings), hEvent, pvContext, phDrt   ; 戻り値は stat
; pSettings : DRT_SETTINGS* -> "sptr"
; hEvent : HANDLE optional -> "sptr"
; pvContext : void* optional -> "sptr"
; phDrt : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "drt.dll"
#cfunc global DrtOpen "DrtOpen" var, sptr, sptr, sptr
; res = DrtOpen(pSettings, hEvent, pvContext, phDrt)
; pSettings : DRT_SETTINGS* -> "var"
; hEvent : HANDLE optional -> "sptr"
; pvContext : void* optional -> "sptr"
; phDrt : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "drt.dll"
#cfunc global DrtOpen "DrtOpen" sptr, sptr, sptr, sptr
; res = DrtOpen(varptr(pSettings), hEvent, pvContext, phDrt)
; pSettings : DRT_SETTINGS* -> "sptr"
; hEvent : HANDLE optional -> "sptr"
; pvContext : void* optional -> "sptr"
; phDrt : void** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。