Win32 API 日本語リファレンス
ホームNetworking.WinInet › InternetCheckConnectionW

InternetCheckConnectionW

関数
指定URLへの接続可否を確認する(Unicode版)。
DLLWININET.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL InternetCheckConnectionW(
    LPCWSTR lpszUrl,
    DWORD dwFlags,
    DWORD dwReserved
);

パラメーター

名前方向説明
lpszUrlLPCWSTRin接続の確認に使用する URL を指定する null 終端文字列へのポインター。この値は NULL でもかまいません。
dwFlagsDWORDin

オプション。現在使用できるフラグは FLAG_ICC_FORCE_CONNECTION のみです。このフラグを設定すると、接続が強制されます。ソケット接続は次の順序で試行されます。

  • lpszUrl が非 NULL の場合、そこからホスト値が抽出され、その特定のホストに対する ping に使用されます。
  • lpszUrlNULL で、最も近いサーバーに関するエントリが内部サーバーデータベースに存在する場合、そのエントリからホスト値が抽出され、そのサーバーに対する ping に使用されます。
dwReservedDWORDinこのパラメーターは予約されており、0 にする必要があります。

戻り値の型: BOOL

公式ドキュメント

アプリケーションがインターネットへの接続を確立できるかどうかを確認できるようにします。(Unicode)

戻り値

接続が正常に確立された場合は TRUE を、それ以外の場合は FALSE を返します。エラーコードを取得するには GetLastError を使用してください。接続を確立できない場合、またはソケットデータベースが無条件でオフラインの場合、 GetLastErrorERROR_NOT_CONNECTED を返します。

解説(Remarks)

InternetCheckConnection は非推奨です。InternetCheckConnection は、インターネットへのアクセスに Web プロキシサーバーを使用する環境では動作しません。インターネットアクセスの確認には、環境に応じて NetworkInformation.GetInternetConnectionProfile または NLM Interfaces を代わりに使用してください。

Note WinINet はサーバー実装をサポートしていません。また、サービスから使用すべきではありません。サーバー実装やサービスでは Microsoft Windows HTTP Services (WinHTTP) を使用してください。
メモ

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

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

各言語での呼び出し定義

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

BOOL InternetCheckConnectionW(
    LPCWSTR lpszUrl,
    DWORD dwFlags,
    DWORD dwReserved
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool InternetCheckConnectionW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpszUrl,   // LPCWSTR
    uint dwFlags,   // DWORD
    uint dwReserved   // DWORD
);
<DllImport("WININET.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InternetCheckConnectionW(
    <MarshalAs(UnmanagedType.LPWStr)> lpszUrl As String,   ' LPCWSTR
    dwFlags As UInteger,   ' DWORD
    dwReserved As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpszUrl : LPCWSTR
' dwFlags : DWORD
' dwReserved : DWORD
Declare PtrSafe Function InternetCheckConnectionW Lib "wininet" ( _
    ByVal lpszUrl As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal dwReserved As Long) 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

InternetCheckConnectionW = ctypes.windll.wininet.InternetCheckConnectionW
InternetCheckConnectionW.restype = wintypes.BOOL
InternetCheckConnectionW.argtypes = [
    wintypes.LPCWSTR,  # lpszUrl : LPCWSTR
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.DWORD,  # dwReserved : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
InternetCheckConnectionW = Fiddle::Function.new(
  lib['InternetCheckConnectionW'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrl : LPCWSTR
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    -Fiddle::TYPE_INT,  # dwReserved : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "wininet")]
extern "system" {
    fn InternetCheckConnectionW(
        lpszUrl: *const u16,  // LPCWSTR
        dwFlags: u32,  // DWORD
        dwReserved: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool InternetCheckConnectionW([MarshalAs(UnmanagedType.LPWStr)] string lpszUrl, uint dwFlags, uint dwReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetCheckConnectionW' -Namespace Win32 -PassThru
# $api::InternetCheckConnectionW(lpszUrl, dwFlags, dwReserved)
#uselib "WININET.dll"
#func global InternetCheckConnectionW "InternetCheckConnectionW" wptr, wptr, wptr
; InternetCheckConnectionW lpszUrl, dwFlags, dwReserved   ; 戻り値は stat
; lpszUrl : LPCWSTR -> "wptr"
; dwFlags : DWORD -> "wptr"
; dwReserved : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WININET.dll"
#cfunc global InternetCheckConnectionW "InternetCheckConnectionW" wstr, int, int
; res = InternetCheckConnectionW(lpszUrl, dwFlags, dwReserved)
; lpszUrl : LPCWSTR -> "wstr"
; dwFlags : DWORD -> "int"
; dwReserved : DWORD -> "int"
; BOOL InternetCheckConnectionW(LPCWSTR lpszUrl, DWORD dwFlags, DWORD dwReserved)
#uselib "WININET.dll"
#cfunc global InternetCheckConnectionW "InternetCheckConnectionW" wstr, int, int
; res = InternetCheckConnectionW(lpszUrl, dwFlags, dwReserved)
; lpszUrl : LPCWSTR -> "wstr"
; dwFlags : DWORD -> "int"
; dwReserved : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procInternetCheckConnectionW = wininet.NewProc("InternetCheckConnectionW")
)

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

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

typedef InternetCheckConnectionWNative = Int32 Function(Pointer<Utf16>, Uint32, Uint32);
typedef InternetCheckConnectionWDart = int Function(Pointer<Utf16>, int, int);
final InternetCheckConnectionW = DynamicLibrary.open('WININET.dll')
    .lookupFunction<InternetCheckConnectionWNative, InternetCheckConnectionWDart>('InternetCheckConnectionW');
// lpszUrl : LPCWSTR -> Pointer<Utf16>
// dwFlags : DWORD -> Uint32
// dwReserved : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function InternetCheckConnectionW(
  lpszUrl: PWideChar;   // LPCWSTR
  dwFlags: DWORD;   // DWORD
  dwReserved: DWORD   // DWORD
): BOOL; stdcall;
  external 'WININET.dll' name 'InternetCheckConnectionW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "InternetCheckConnectionW"
  c_InternetCheckConnectionW :: CWString -> Word32 -> Word32 -> IO CInt
-- lpszUrl : LPCWSTR -> CWString
-- dwFlags : DWORD -> Word32
-- dwReserved : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let internetcheckconnectionw =
  foreign "InternetCheckConnectionW"
    ((ptr uint16_t) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* lpszUrl : LPCWSTR -> (ptr uint16_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* dwReserved : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wininet (t "WININET.dll"))
(cffi:use-foreign-library wininet)

(cffi:defcfun ("InternetCheckConnectionW" internet-check-connection-w :convention :stdcall) :int32
  (lpsz-url (:string :encoding :utf-16le))   ; LPCWSTR
  (dw-flags :uint32)   ; DWORD
  (dw-reserved :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $InternetCheckConnectionW = Win32::API::More->new('WININET',
    'BOOL InternetCheckConnectionW(LPCWSTR lpszUrl, DWORD dwFlags, DWORD dwReserved)');
# my $ret = $InternetCheckConnectionW->Call($lpszUrl, $dwFlags, $dwReserved);
# lpszUrl : LPCWSTR -> LPCWSTR
# dwFlags : DWORD -> DWORD
# dwReserved : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い