Win32 API 日本語リファレンス
ホームSystem.EventNotificationService › IsDestinationReachableA

IsDestinationReachableA

関数
指定宛先への到達可能性を確認する(ANSI版)。
DLLSensApi.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// SensApi.dll  (ANSI / -A)
#include <windows.h>

BOOL IsDestinationReachableA(
    LPCSTR lpszDestination,
    QOCINFO* lpQOCInfo
);

パラメーター

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

戻り値の型: BOOL

各言語での呼び出し定義

// SensApi.dll  (ANSI / -A)
#include <windows.h>

BOOL IsDestinationReachableA(
    LPCSTR lpszDestination,
    QOCINFO* lpQOCInfo
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SensApi.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool IsDestinationReachableA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszDestination,   // LPCSTR
    IntPtr lpQOCInfo   // QOCINFO* in/out
);
<DllImport("SensApi.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function IsDestinationReachableA(
    <MarshalAs(UnmanagedType.LPStr)> lpszDestination As String,   ' LPCSTR
    lpQOCInfo As IntPtr   ' QOCINFO* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpszDestination : LPCSTR
' lpQOCInfo : QOCINFO* in/out
Declare PtrSafe Function IsDestinationReachableA Lib "sensapi" ( _
    ByVal lpszDestination As String, _
    ByVal lpQOCInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

IsDestinationReachableA = ctypes.windll.sensapi.IsDestinationReachableA
IsDestinationReachableA.restype = wintypes.BOOL
IsDestinationReachableA.argtypes = [
    wintypes.LPCSTR,  # lpszDestination : LPCSTR
    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')
IsDestinationReachableA = Fiddle::Function.new(
  lib['IsDestinationReachableA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszDestination : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpQOCInfo : QOCINFO* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "sensapi")]
extern "system" {
    fn IsDestinationReachableA(
        lpszDestination: *const u8,  // LPCSTR
        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.Ansi, SetLastError = true)]
public static extern bool IsDestinationReachableA([MarshalAs(UnmanagedType.LPStr)] string lpszDestination, IntPtr lpQOCInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SensApi_IsDestinationReachableA' -Namespace Win32 -PassThru
# $api::IsDestinationReachableA(lpszDestination, lpQOCInfo)
#uselib "SensApi.dll"
#func global IsDestinationReachableA "IsDestinationReachableA" sptr, sptr
; IsDestinationReachableA lpszDestination, varptr(lpQOCInfo)   ; 戻り値は stat
; lpszDestination : LPCSTR -> "sptr"
; lpQOCInfo : QOCINFO* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SensApi.dll"
#cfunc global IsDestinationReachableA "IsDestinationReachableA" str, var
; res = IsDestinationReachableA(lpszDestination, lpQOCInfo)
; lpszDestination : LPCSTR -> "str"
; lpQOCInfo : QOCINFO* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL IsDestinationReachableA(LPCSTR lpszDestination, QOCINFO* lpQOCInfo)
#uselib "SensApi.dll"
#cfunc global IsDestinationReachableA "IsDestinationReachableA" str, var
; res = IsDestinationReachableA(lpszDestination, lpQOCInfo)
; lpszDestination : LPCSTR -> "str"
; lpQOCInfo : QOCINFO* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	sensapi = windows.NewLazySystemDLL("SensApi.dll")
	procIsDestinationReachableA = sensapi.NewProc("IsDestinationReachableA")
)

// lpszDestination (LPCSTR), lpQOCInfo (QOCINFO* in/out)
r1, _, err := procIsDestinationReachableA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszDestination))),
	uintptr(lpQOCInfo),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function IsDestinationReachableA(
  lpszDestination: PAnsiChar;   // LPCSTR
  lpQOCInfo: Pointer   // QOCINFO* in/out
): BOOL; stdcall;
  external 'SensApi.dll' name 'IsDestinationReachableA';
result := DllCall("SensApi\IsDestinationReachableA"
    , "AStr", lpszDestination   ; LPCSTR
    , "Ptr", lpQOCInfo   ; QOCINFO* in/out
    , "Int")   ; return: BOOL
●IsDestinationReachableA(lpszDestination, lpQOCInfo) = DLL("SensApi.dll", "bool IsDestinationReachableA(char*, void*)")
# 呼び出し: IsDestinationReachableA(lpszDestination, lpQOCInfo)
# lpszDestination : LPCSTR -> "char*"
# lpQOCInfo : QOCINFO* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "sensapi" fn IsDestinationReachableA(
    lpszDestination: [*c]const u8, // LPCSTR
    lpQOCInfo: [*c]QOCINFO // QOCINFO* in/out
) callconv(std.os.windows.WINAPI) i32;
proc IsDestinationReachableA(
    lpszDestination: cstring,  # LPCSTR
    lpQOCInfo: ptr QOCINFO  # QOCINFO* in/out
): int32 {.importc: "IsDestinationReachableA", stdcall, dynlib: "SensApi.dll".}
pragma(lib, "sensapi");
extern(Windows)
int IsDestinationReachableA(
    const(char)* lpszDestination,   // LPCSTR
    QOCINFO* lpQOCInfo   // QOCINFO* in/out
);
ccall((:IsDestinationReachableA, "SensApi.dll"), stdcall, Int32,
      (Cstring, Ptr{QOCINFO}),
      lpszDestination, lpQOCInfo)
# lpszDestination : LPCSTR -> Cstring
# lpQOCInfo : QOCINFO* in/out -> Ptr{QOCINFO}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t IsDestinationReachableA(
    const char* lpszDestination,
    void* lpQOCInfo);
]]
local sensapi = ffi.load("sensapi")
-- sensapi.IsDestinationReachableA(lpszDestination, lpQOCInfo)
-- lpszDestination : LPCSTR
-- lpQOCInfo : QOCINFO* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SensApi.dll');
const IsDestinationReachableA = lib.func('__stdcall', 'IsDestinationReachableA', 'int32_t', ['str', 'void *']);
// IsDestinationReachableA(lpszDestination, lpQOCInfo)
// lpszDestination : LPCSTR -> 'str'
// lpQOCInfo : QOCINFO* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SensApi.dll", {
  IsDestinationReachableA: { parameters: ["buffer", "pointer"], result: "i32" },
});
// lib.symbols.IsDestinationReachableA(lpszDestination, lpQOCInfo)
// lpszDestination : LPCSTR -> "buffer"
// lpQOCInfo : QOCINFO* in/out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t IsDestinationReachableA(
    const char* lpszDestination,
    void* lpQOCInfo);
C, "SensApi.dll");
// $ffi->IsDestinationReachableA(lpszDestination, lpQOCInfo);
// lpszDestination : LPCSTR
// 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.ASCII_OPTIONS);
    boolean IsDestinationReachableA(
        String lpszDestination,   // LPCSTR
        Pointer lpQOCInfo   // QOCINFO* in/out
    );
}
@[Link("sensapi")]
lib LibSensApi
  fun IsDestinationReachableA = IsDestinationReachableA(
    lpszDestination : UInt8*,   # LPCSTR
    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 IsDestinationReachableANative = Int32 Function(Pointer<Utf8>, Pointer<Void>);
typedef IsDestinationReachableADart = int Function(Pointer<Utf8>, Pointer<Void>);
final IsDestinationReachableA = DynamicLibrary.open('SensApi.dll')
    .lookupFunction<IsDestinationReachableANative, IsDestinationReachableADart>('IsDestinationReachableA');
// lpszDestination : LPCSTR -> Pointer<Utf8>
// lpQOCInfo : QOCINFO* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function IsDestinationReachableA(
  lpszDestination: PAnsiChar;   // LPCSTR
  lpQOCInfo: Pointer   // QOCINFO* in/out
): BOOL; stdcall;
  external 'SensApi.dll' name 'IsDestinationReachableA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let isdestinationreachablea =
  foreign "IsDestinationReachableA"
    (string @-> (ptr void) @-> returning int32_t)
(* lpszDestination : LPCSTR -> string *)
(* 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 ("IsDestinationReachableA" is-destination-reachable-a :convention :stdcall) :int32
  (lpsz-destination :string)   ; LPCSTR
  (lp-qocinfo :pointer))   ; QOCINFO* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $IsDestinationReachableA = Win32::API::More->new('SensApi',
    'BOOL IsDestinationReachableA(LPCSTR lpszDestination, LPVOID lpQOCInfo)');
# my $ret = $IsDestinationReachableA->Call($lpszDestination, $lpQOCInfo);
# lpszDestination : LPCSTR -> LPCSTR
# lpQOCInfo : QOCINFO* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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