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

OnDemandGetRoutingHint

関数
宛先ホスト名に最適なインターフェイスのルーティングヒントを取得する。
DLLOnDemandConnRouteHelper.dll呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

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

HRESULT OnDemandGetRoutingHint(
    LPCWSTR destinationHostName,
    DWORD* interfaceIndex
);

パラメーター

名前方向説明
destinationHostNameLPCWSTRinルーティング判定の対象となる接続先ホスト名を指す文字列。
interfaceIndexDWORD*out使用すべきインターフェースのインデックスを受け取る出力先。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT OnDemandGetRoutingHint(
    LPCWSTR destinationHostName,
    DWORD* interfaceIndex
);
[DllImport("OnDemandConnRouteHelper.dll", ExactSpelling = true)]
static extern int OnDemandGetRoutingHint(
    [MarshalAs(UnmanagedType.LPWStr)] string destinationHostName,   // LPCWSTR
    out uint interfaceIndex   // DWORD* out
);
<DllImport("OnDemandConnRouteHelper.dll", ExactSpelling:=True)>
Public Shared Function OnDemandGetRoutingHint(
    <MarshalAs(UnmanagedType.LPWStr)> destinationHostName As String,   ' LPCWSTR
    <Out> ByRef interfaceIndex As UInteger   ' DWORD* out
) As Integer
End Function
' destinationHostName : LPCWSTR
' interfaceIndex : DWORD* out
Declare PtrSafe Function OnDemandGetRoutingHint Lib "ondemandconnroutehelper" ( _
    ByVal destinationHostName As LongPtr, _
    ByRef interfaceIndex As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

OnDemandGetRoutingHint = ctypes.windll.ondemandconnroutehelper.OnDemandGetRoutingHint
OnDemandGetRoutingHint.restype = ctypes.c_int
OnDemandGetRoutingHint.argtypes = [
    wintypes.LPCWSTR,  # destinationHostName : LPCWSTR
    ctypes.POINTER(wintypes.DWORD),  # interfaceIndex : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OnDemandConnRouteHelper.dll')
OnDemandGetRoutingHint = Fiddle::Function.new(
  lib['OnDemandGetRoutingHint'],
  [
    Fiddle::TYPE_VOIDP,  # destinationHostName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # interfaceIndex : DWORD* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "ondemandconnroutehelper")]
extern "system" {
    fn OnDemandGetRoutingHint(
        destinationHostName: *const u16,  // LPCWSTR
        interfaceIndex: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OnDemandConnRouteHelper.dll")]
public static extern int OnDemandGetRoutingHint([MarshalAs(UnmanagedType.LPWStr)] string destinationHostName, out uint interfaceIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OnDemandConnRouteHelper_OnDemandGetRoutingHint' -Namespace Win32 -PassThru
# $api::OnDemandGetRoutingHint(destinationHostName, interfaceIndex)
#uselib "OnDemandConnRouteHelper.dll"
#func global OnDemandGetRoutingHint "OnDemandGetRoutingHint" sptr, sptr
; OnDemandGetRoutingHint destinationHostName, varptr(interfaceIndex)   ; 戻り値は stat
; destinationHostName : LPCWSTR -> "sptr"
; interfaceIndex : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "OnDemandConnRouteHelper.dll"
#cfunc global OnDemandGetRoutingHint "OnDemandGetRoutingHint" wstr, var
; res = OnDemandGetRoutingHint(destinationHostName, interfaceIndex)
; destinationHostName : LPCWSTR -> "wstr"
; interfaceIndex : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT OnDemandGetRoutingHint(LPCWSTR destinationHostName, DWORD* interfaceIndex)
#uselib "OnDemandConnRouteHelper.dll"
#cfunc global OnDemandGetRoutingHint "OnDemandGetRoutingHint" wstr, var
; res = OnDemandGetRoutingHint(destinationHostName, interfaceIndex)
; destinationHostName : LPCWSTR -> "wstr"
; interfaceIndex : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ondemandconnroutehelper = windows.NewLazySystemDLL("OnDemandConnRouteHelper.dll")
	procOnDemandGetRoutingHint = ondemandconnroutehelper.NewProc("OnDemandGetRoutingHint")
)

// destinationHostName (LPCWSTR), interfaceIndex (DWORD* out)
r1, _, err := procOnDemandGetRoutingHint.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(destinationHostName))),
	uintptr(interfaceIndex),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function OnDemandGetRoutingHint(
  destinationHostName: PWideChar;   // LPCWSTR
  interfaceIndex: Pointer   // DWORD* out
): Integer; stdcall;
  external 'OnDemandConnRouteHelper.dll' name 'OnDemandGetRoutingHint';
result := DllCall("OnDemandConnRouteHelper\OnDemandGetRoutingHint"
    , "WStr", destinationHostName   ; LPCWSTR
    , "Ptr", interfaceIndex   ; DWORD* out
    , "Int")   ; return: HRESULT
●OnDemandGetRoutingHint(destinationHostName, interfaceIndex) = DLL("OnDemandConnRouteHelper.dll", "int OnDemandGetRoutingHint(char*, void*)")
# 呼び出し: OnDemandGetRoutingHint(destinationHostName, interfaceIndex)
# destinationHostName : LPCWSTR -> "char*"
# interfaceIndex : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef OnDemandGetRoutingHintNative = Int32 Function(Pointer<Utf16>, Pointer<Uint32>);
typedef OnDemandGetRoutingHintDart = int Function(Pointer<Utf16>, Pointer<Uint32>);
final OnDemandGetRoutingHint = DynamicLibrary.open('OnDemandConnRouteHelper.dll')
    .lookupFunction<OnDemandGetRoutingHintNative, OnDemandGetRoutingHintDart>('OnDemandGetRoutingHint');
// destinationHostName : LPCWSTR -> Pointer<Utf16>
// interfaceIndex : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OnDemandGetRoutingHint(
  destinationHostName: PWideChar;   // LPCWSTR
  interfaceIndex: Pointer   // DWORD* out
): Integer; stdcall;
  external 'OnDemandConnRouteHelper.dll' name 'OnDemandGetRoutingHint';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OnDemandGetRoutingHint"
  c_OnDemandGetRoutingHint :: CWString -> Ptr Word32 -> IO Int32
-- destinationHostName : LPCWSTR -> CWString
-- interfaceIndex : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ondemandgetroutinghint =
  foreign "OnDemandGetRoutingHint"
    ((ptr uint16_t) @-> (ptr uint32_t) @-> returning int32_t)
(* destinationHostName : LPCWSTR -> (ptr uint16_t) *)
(* interfaceIndex : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ondemandconnroutehelper (t "OnDemandConnRouteHelper.dll"))
(cffi:use-foreign-library ondemandconnroutehelper)

(cffi:defcfun ("OnDemandGetRoutingHint" on-demand-get-routing-hint :convention :stdcall) :int32
  (destination-host-name (:string :encoding :utf-16le))   ; LPCWSTR
  (interface-index :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OnDemandGetRoutingHint = Win32::API::More->new('OnDemandConnRouteHelper',
    'int OnDemandGetRoutingHint(LPCWSTR destinationHostName, LPVOID interfaceIndex)');
# my $ret = $OnDemandGetRoutingHint->Call($destinationHostName, $interfaceIndex);
# destinationHostName : LPCWSTR -> LPCWSTR
# interfaceIndex : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。