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

InternetGetConnectedState

関数
現在のインターネット接続状態を取得する。
DLLWININET.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL InternetGetConnectedState(
    INTERNET_CONNECTION* lpdwFlags,
    DWORD dwReserved   // optional
);

パラメーター

名前方向説明
lpdwFlagsINTERNET_CONNECTION*out

接続の説明を受け取る変数へのポインターです。このパラメーターは、関数が FALSE を返す場合でも有効なフラグを返すことがあります。このパラメーターには、次の値の 1 つ以上を指定できます。

意味
INTERNET_CONNECTION_CONFIGURED
0x40
ローカルシステムはインターネットへの有効な接続を持っていますが、現在接続されているとは限りません。
INTERNET_CONNECTION_LAN
0x02
ローカルシステムはローカルエリアネットワークを使用してインターネットに接続しています。
INTERNET_CONNECTION_MODEM
0x01
ローカルシステムはモデムを使用してインターネットに接続しています。
INTERNET_CONNECTION_MODEM_BUSY
0x08
現在は使用されていません。
INTERNET_CONNECTION_OFFLINE
0x20
ローカルシステムはオフラインモードです。
INTERNET_CONNECTION_PROXY
0x04
ローカルシステムはプロキシサーバーを使用してインターネットに接続しています。
INTERNET_RAS_INSTALLED
0x10
ローカルシステムに RAS がインストールされています。
dwReservedDWORDoptionalこのパラメーターは予約されており、0 を指定する必要があります。

戻り値の型: BOOL

公式ドキュメント

InternetGetConnectedState 関数 (wininet.h) は、ローカルシステムの接続状態を取得します。この関数の使用は推奨されません。

戻り値

アクティブなモデム接続または LAN インターネット接続がある場合は TRUE を返します。インターネット接続が存在しない場合、またはすべてのインターネット接続が現在アクティブでない場合は FALSE を返します。詳細については、「解説」セクションを参照してください。

InternetGetConnectedStateFALSE を返した場合、アプリケーションは GetLastError を呼び出してエラーコードを取得できます。

解説(Remarks)

InternetGetConnectedStateTRUE を返す場合、少なくとも 1 つのインターネット接続が利用可能であることを示します。ただし、特定のホストへの接続を確立できることを保証するものではありません。アプリケーションは、サーバーに接続する API 呼び出しから返されるエラーを常に確認する必要があります。特定の宛先への接続を確立できるかどうかを判断するには、InternetCheckConnection を呼び出すことができます。

戻り値が TRUE の場合、モデム接続がアクティブであるか、LAN 接続がアクティブで LAN 用のプロキシが適切に構成されていることを示します。戻り値が FALSE の場合、モデムも LAN も接続されていないことを示します。FALSE が返された場合、自動ダイヤルが「常にダイヤルする」ように構成されているが現在アクティブでないことを示すために INTERNET_CONNECTION_CONFIGURED フラグが設定されることがあります。自動ダイヤルが構成されていない場合、関数は FALSE を返します。

WinINet API の他のすべての側面と同様に、この関数は DllMain 内やグローバルオブジェクトのコンストラクター・デストラクター内から安全に呼び出すことはできません。

注意 WinINet はサーバー実装をサポートしていません。また、サービスから使用すべきではありません。サーバー実装やサービスには、Microsoft Windows HTTP Services (WinHTTP) を使用してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

BOOL InternetGetConnectedState(
    INTERNET_CONNECTION* lpdwFlags,
    DWORD dwReserved   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", SetLastError = true, ExactSpelling = true)]
static extern bool InternetGetConnectedState(
    out uint lpdwFlags,   // INTERNET_CONNECTION* out
    uint dwReserved   // DWORD optional
);
<DllImport("WININET.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InternetGetConnectedState(
    <Out> ByRef lpdwFlags As UInteger,   ' INTERNET_CONNECTION* out
    dwReserved As UInteger   ' DWORD optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpdwFlags : INTERNET_CONNECTION* out
' dwReserved : DWORD optional
Declare PtrSafe Function InternetGetConnectedState Lib "wininet" ( _
    ByRef lpdwFlags As Long, _
    ByVal dwReserved As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

InternetGetConnectedState = ctypes.windll.wininet.InternetGetConnectedState
InternetGetConnectedState.restype = wintypes.BOOL
InternetGetConnectedState.argtypes = [
    ctypes.c_void_p,  # lpdwFlags : INTERNET_CONNECTION* out
    wintypes.DWORD,  # dwReserved : DWORD optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procInternetGetConnectedState = wininet.NewProc("InternetGetConnectedState")
)

// lpdwFlags (INTERNET_CONNECTION* out), dwReserved (DWORD optional)
r1, _, err := procInternetGetConnectedState.Call(
	uintptr(lpdwFlags),
	uintptr(dwReserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function InternetGetConnectedState(
  lpdwFlags: Pointer;   // INTERNET_CONNECTION* out
  dwReserved: DWORD   // DWORD optional
): BOOL; stdcall;
  external 'WININET.dll' name 'InternetGetConnectedState';
result := DllCall("WININET\InternetGetConnectedState"
    , "Ptr", lpdwFlags   ; INTERNET_CONNECTION* out
    , "UInt", dwReserved   ; DWORD optional
    , "Int")   ; return: BOOL
●InternetGetConnectedState(lpdwFlags, dwReserved) = DLL("WININET.dll", "bool InternetGetConnectedState(void*, dword)")
# 呼び出し: InternetGetConnectedState(lpdwFlags, dwReserved)
# lpdwFlags : INTERNET_CONNECTION* out -> "void*"
# dwReserved : DWORD optional -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef InternetGetConnectedStateNative = Int32 Function(Pointer<Uint32>, Uint32);
typedef InternetGetConnectedStateDart = int Function(Pointer<Uint32>, int);
final InternetGetConnectedState = DynamicLibrary.open('WININET.dll')
    .lookupFunction<InternetGetConnectedStateNative, InternetGetConnectedStateDart>('InternetGetConnectedState');
// lpdwFlags : INTERNET_CONNECTION* out -> Pointer<Uint32>
// dwReserved : DWORD optional -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function InternetGetConnectedState(
  lpdwFlags: Pointer;   // INTERNET_CONNECTION* out
  dwReserved: DWORD   // DWORD optional
): BOOL; stdcall;
  external 'WININET.dll' name 'InternetGetConnectedState';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "InternetGetConnectedState"
  c_InternetGetConnectedState :: Ptr Word32 -> Word32 -> IO CInt
-- lpdwFlags : INTERNET_CONNECTION* out -> Ptr Word32
-- dwReserved : DWORD optional -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("InternetGetConnectedState" internet-get-connected-state :convention :stdcall) :int32
  (lpdw-flags :pointer)   ; INTERNET_CONNECTION* out
  (dw-reserved :uint32))   ; DWORD optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $InternetGetConnectedState = Win32::API::More->new('WININET',
    'BOOL InternetGetConnectedState(LPVOID lpdwFlags, DWORD dwReserved)');
# my $ret = $InternetGetConnectedState->Call($lpdwFlags, $dwReserved);
# lpdwFlags : INTERNET_CONNECTION* out -> LPVOID
# dwReserved : DWORD optional -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型