ホーム › System.EventNotificationService › IsDestinationReachableW

IsDestinationReachableW

関数

指定宛先への到達可能性を確認する(Unicode版)。

DLLSensApi.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// SensApi.dll  (Unicode / -W)
#include <windows.h>

BOOL IsDestinationReachableW(
    LPCWSTR lpszDestination,
    QOCINFO* lpQOCInfo
);

パラメーター

名前	型	方向	説明
lpszDestination	LPCWSTR	in	宛先を指定する null 終端文字列へのポインターです。宛先には、IP アドレス、UNC 名、または URL を指定できます。
lpQOCInfo	QOCINFO*	inout	接続品質 (QOC) 情報を受け取る QOCINFO 構造体へのポインターです。QOC 情報が不要な場合は、NULL ポインターを指定できます。

戻り値の型: BOOL

公式ドキュメント

IsDestinationReachable 関数は、指定した宛先に到達できるかどうかを判定し、その宛先に関する接続品質 (QOC: Quality of Connection) 情報を提供します。(Unicode)

戻り値

戻り値	説明
TRUE	宛先に到達できます。
FALSE	宛先に到達できません。拡張エラー情報を取得するには、 GetLastError を呼び出します。
ERROR_CALL_NOT_IMPLEMENTED	この関数は Windows Vista では利用できません。

解説(Remarks)

クライアントアプリケーションは、ネットワーク操作を実行する前に QOC 情報を判定するためにこの関数を使用します。ネットワークカードまたはリモートアクセスサーバー (RAS) を通じてネットワークに直接接続されているスタンドアロンコンピューターの場合、この関数は最も近いルーターへの RPC 呼び出しによって最小限のネットワークトラフィックを生成します。RAS またはネットワークゲートウェイを使用して宛先に到達できるネットワークに属するコンピューターの場合、この関数は宛先に ping を実行して正確な QOC 情報を生成します。

この関数は TCP/IP 接続でのみ利用できます。呼び出し元は QOCINFO 構造体用のバッファーを用意し、不要になった時点でそのメモリを解放する必要があります。

Windows Vista および Windows Server 2008 向けに設計されたアプリケーション以降では、この関数の代わりに Network List Manager の使用を検討してください。

メモ

sensapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして IsDestinationReachable を定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となる場合があります。詳細については、「Conventions for Function Prototypes」を参照してください。

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

各言語での呼び出し定義

// SensApi.dll  (Unicode / -W)
#include <windows.h>

BOOL IsDestinationReachableW(
    LPCWSTR lpszDestination,
    QOCINFO* lpQOCInfo
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SensApi.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool IsDestinationReachableW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpszDestination,   // LPCWSTR
    IntPtr lpQOCInfo   // QOCINFO* in/out
);

<DllImport("SensApi.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function IsDestinationReachableW(
    <MarshalAs(UnmanagedType.LPWStr)> lpszDestination As String,   ' LPCWSTR
    lpQOCInfo As IntPtr   ' QOCINFO* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpszDestination : LPCWSTR
' lpQOCInfo : QOCINFO* in/out
Declare PtrSafe Function IsDestinationReachableW Lib "sensapi" ( _
    ByVal lpszDestination As LongPtr, _
    ByVal lpQOCInfo As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

IsDestinationReachableW = ctypes.windll.sensapi.IsDestinationReachableW
IsDestinationReachableW.restype = wintypes.BOOL
IsDestinationReachableW.argtypes = [
    wintypes.LPCWSTR,  # lpszDestination : LPCWSTR
    ctypes.c_void_p,  # lpQOCInfo : QOCINFO* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SensApi.dll')
IsDestinationReachableW = Fiddle::Function.new(
  lib['IsDestinationReachableW'],
  [
    Fiddle::TYPE_VOIDP,  # lpszDestination : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpQOCInfo : QOCINFO* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "sensapi")]
extern "system" {
    fn IsDestinationReachableW(
        lpszDestination: *const u16,  // LPCWSTR
        lpQOCInfo: *mut QOCINFO  // QOCINFO* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SensApi.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool IsDestinationReachableW([MarshalAs(UnmanagedType.LPWStr)] string lpszDestination, IntPtr lpQOCInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SensApi_IsDestinationReachableW' -Namespace Win32 -PassThru
# $api::IsDestinationReachableW(lpszDestination, lpQOCInfo)

#uselib "SensApi.dll"
#func global IsDestinationReachableW "IsDestinationReachableW" wptr, wptr
; IsDestinationReachableW lpszDestination, varptr(lpQOCInfo)   ; 戻り値は stat
; lpszDestination : LPCWSTR -> "wptr"
; lpQOCInfo : QOCINFO* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SensApi.dll"
#cfunc global IsDestinationReachableW "IsDestinationReachableW" wstr, var
; res = IsDestinationReachableW(lpszDestination, lpQOCInfo)
; lpszDestination : LPCWSTR -> "wstr"
; lpQOCInfo : QOCINFO* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SensApi.dll"
#cfunc global IsDestinationReachableW "IsDestinationReachableW" wstr, sptr
; res = IsDestinationReachableW(lpszDestination, varptr(lpQOCInfo))
; lpszDestination : LPCWSTR -> "wstr"
; lpQOCInfo : QOCINFO* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。