Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向説明
lpszDestinationLPCWSTRin到達可否を判定する宛先のホスト名・IP・URL等の文字列(Unicode)。
lpQOCInfoQOCINFO*inout接続の品質情報を受け取るQOCINFO構造体へのポインタ。NULL可で可否のみ判定する。

戻り値の型: BOOL

各言語での呼び出し定義

// 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 方式にも切替可。
出力引数:
; BOOL IsDestinationReachableW(LPCWSTR lpszDestination, QOCINFO* lpQOCInfo)
#uselib "SensApi.dll"
#cfunc global IsDestinationReachableW "IsDestinationReachableW" wstr, var
; res = IsDestinationReachableW(lpszDestination, lpQOCInfo)
; lpszDestination : LPCWSTR -> "wstr"
; lpQOCInfo : QOCINFO* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	sensapi = windows.NewLazySystemDLL("SensApi.dll")
	procIsDestinationReachableW = sensapi.NewProc("IsDestinationReachableW")
)

// lpszDestination (LPCWSTR), lpQOCInfo (QOCINFO* in/out)
r1, _, err := procIsDestinationReachableW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszDestination))),
	uintptr(lpQOCInfo),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function IsDestinationReachableW(
  lpszDestination: PWideChar;   // LPCWSTR
  lpQOCInfo: Pointer   // QOCINFO* in/out
): BOOL; stdcall;
  external 'SensApi.dll' name 'IsDestinationReachableW';
result := DllCall("SensApi\IsDestinationReachableW"
    , "WStr", lpszDestination   ; LPCWSTR
    , "Ptr", lpQOCInfo   ; QOCINFO* in/out
    , "Int")   ; return: BOOL
●IsDestinationReachableW(lpszDestination, lpQOCInfo) = DLL("SensApi.dll", "bool IsDestinationReachableW(char*, void*)")
# 呼び出し: IsDestinationReachableW(lpszDestination, lpQOCInfo)
# lpszDestination : LPCWSTR -> "char*"
# lpQOCInfo : QOCINFO* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "sensapi" fn IsDestinationReachableW(
    lpszDestination: [*c]const u16, // LPCWSTR
    lpQOCInfo: [*c]QOCINFO // QOCINFO* in/out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc IsDestinationReachableW(
    lpszDestination: WideCString,  # LPCWSTR
    lpQOCInfo: ptr QOCINFO  # QOCINFO* in/out
): int32 {.importc: "IsDestinationReachableW", stdcall, dynlib: "SensApi.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "sensapi");
extern(Windows)
int IsDestinationReachableW(
    const(wchar)* lpszDestination,   // LPCWSTR
    QOCINFO* lpQOCInfo   // QOCINFO* in/out
);
ccall((:IsDestinationReachableW, "SensApi.dll"), stdcall, Int32,
      (Cwstring, Ptr{QOCINFO}),
      lpszDestination, lpQOCInfo)
# lpszDestination : LPCWSTR -> Cwstring
# lpQOCInfo : QOCINFO* in/out -> Ptr{QOCINFO}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t IsDestinationReachableW(
    const uint16_t* lpszDestination,
    void* lpQOCInfo);
]]
local sensapi = ffi.load("sensapi")
-- sensapi.IsDestinationReachableW(lpszDestination, lpQOCInfo)
-- lpszDestination : LPCWSTR
-- lpQOCInfo : QOCINFO* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SensApi.dll');
const IsDestinationReachableW = lib.func('__stdcall', 'IsDestinationReachableW', 'int32_t', ['str16', 'void *']);
// IsDestinationReachableW(lpszDestination, lpQOCInfo)
// lpszDestination : LPCWSTR -> 'str16'
// lpQOCInfo : QOCINFO* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SensApi.dll", {
  IsDestinationReachableW: { parameters: ["buffer", "pointer"], result: "i32" },
});
// lib.symbols.IsDestinationReachableW(lpszDestination, lpQOCInfo)
// lpszDestination : LPCWSTR -> "buffer"
// lpQOCInfo : QOCINFO* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t IsDestinationReachableW(
    const uint16_t* lpszDestination,
    void* lpQOCInfo);
C, "SensApi.dll");
// $ffi->IsDestinationReachableW(lpszDestination, lpQOCInfo);
// lpszDestination : LPCWSTR
// lpQOCInfo : QOCINFO* in/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 Sensapi extends StdCallLibrary {
    Sensapi INSTANCE = Native.load("sensapi", Sensapi.class, W32APIOptions.UNICODE_OPTIONS);
    boolean IsDestinationReachableW(
        WString lpszDestination,   // LPCWSTR
        Pointer lpQOCInfo   // QOCINFO* in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("sensapi")]
lib LibSensApi
  fun IsDestinationReachableW = IsDestinationReachableW(
    lpszDestination : UInt16*,   # LPCWSTR
    lpQOCInfo : QOCINFO*   # QOCINFO* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef IsDestinationReachableWNative = Int32 Function(Pointer<Utf16>, Pointer<Void>);
typedef IsDestinationReachableWDart = int Function(Pointer<Utf16>, Pointer<Void>);
final IsDestinationReachableW = DynamicLibrary.open('SensApi.dll')
    .lookupFunction<IsDestinationReachableWNative, IsDestinationReachableWDart>('IsDestinationReachableW');
// lpszDestination : LPCWSTR -> Pointer<Utf16>
// lpQOCInfo : QOCINFO* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function IsDestinationReachableW(
  lpszDestination: PWideChar;   // LPCWSTR
  lpQOCInfo: Pointer   // QOCINFO* in/out
): BOOL; stdcall;
  external 'SensApi.dll' name 'IsDestinationReachableW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "IsDestinationReachableW"
  c_IsDestinationReachableW :: CWString -> Ptr () -> IO CInt
-- lpszDestination : LPCWSTR -> CWString
-- lpQOCInfo : QOCINFO* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let isdestinationreachablew =
  foreign "IsDestinationReachableW"
    ((ptr uint16_t) @-> (ptr void) @-> returning int32_t)
(* lpszDestination : LPCWSTR -> (ptr uint16_t) *)
(* lpQOCInfo : QOCINFO* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library sensapi (t "SensApi.dll"))
(cffi:use-foreign-library sensapi)

(cffi:defcfun ("IsDestinationReachableW" is-destination-reachable-w :convention :stdcall) :int32
  (lpsz-destination (:string :encoding :utf-16le))   ; LPCWSTR
  (lp-qocinfo :pointer))   ; QOCINFO* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $IsDestinationReachableW = Win32::API::More->new('SensApi',
    'BOOL IsDestinationReachableW(LPCWSTR lpszDestination, LPVOID lpQOCInfo)');
# my $ret = $IsDestinationReachableW->Call($lpszDestination, $lpQOCInfo);
# lpszDestination : LPCWSTR -> LPCWSTR
# lpQOCInfo : QOCINFO* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型