ホーム › Networking.WinInet › InternetGetConnectedStateEx

InternetGetConnectedStateEx

関数

接続状態と接続名を取得する拡張版。

DLLWININET.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL InternetGetConnectedStateEx(
    INTERNET_CONNECTION* lpdwFlags,
    LPSTR lpszConnectionName,   // optional
    DWORD dwNameLen,
    DWORD dwReserved
);

パラメーター

名前

型

方向

説明

lpdwFlags

INTERNET_CONNECTION*

out

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

値	意味
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	ローカルシステムはプロキシサーバーを使用してインターネットに接続しています。

lpszConnectionName

LPSTR

outoptional

接続名を受け取る文字列値へのポインター。

dwNameLen

DWORD

lpszConnectionName 文字列のサイズ(TCHAR 単位)。

dwReserved

DWORD

このパラメーターは予約されており、NULL を指定する必要があります。

戻り値の型: BOOL

公式ドキュメント

InternetGetConnectedStateEx 関数 (wininet.h) は、指定したインターネット接続の接続状態を取得します。この関数の使用は推奨されません。

戻り値

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

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

解説(Remarks)

InternetGetConnectedState からの戻り値 TRUE は、インターネットへの接続が少なくとも 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  (ANSI / -A)
#include <windows.h>

BOOL InternetGetConnectedStateEx(
    INTERNET_CONNECTION* lpdwFlags,
    LPSTR lpszConnectionName,   // optional
    DWORD dwNameLen,
    DWORD dwReserved
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool InternetGetConnectedStateEx(
    out uint lpdwFlags,   // INTERNET_CONNECTION* out
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszConnectionName,   // LPSTR optional, out
    uint dwNameLen,   // DWORD
    uint dwReserved   // DWORD
);

<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InternetGetConnectedStateEx(
    <Out> ByRef lpdwFlags As UInteger,   ' INTERNET_CONNECTION* out
    <MarshalAs(UnmanagedType.LPStr)> lpszConnectionName As System.Text.StringBuilder,   ' LPSTR optional, out
    dwNameLen As UInteger,   ' DWORD
    dwReserved As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpdwFlags : INTERNET_CONNECTION* out
' lpszConnectionName : LPSTR optional, out
' dwNameLen : DWORD
' dwReserved : DWORD
Declare PtrSafe Function InternetGetConnectedStateEx Lib "wininet" ( _
    ByRef lpdwFlags As Long, _
    ByVal lpszConnectionName As String, _
    ByVal dwNameLen 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

InternetGetConnectedStateEx = ctypes.windll.wininet.InternetGetConnectedStateEx
InternetGetConnectedStateEx.restype = wintypes.BOOL
InternetGetConnectedStateEx.argtypes = [
    ctypes.c_void_p,  # lpdwFlags : INTERNET_CONNECTION* out
    wintypes.LPSTR,  # lpszConnectionName : LPSTR optional, out
    wintypes.DWORD,  # dwNameLen : 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')
InternetGetConnectedStateEx = Fiddle::Function.new(
  lib['InternetGetConnectedStateEx'],
  [
    Fiddle::TYPE_VOIDP,  # lpdwFlags : INTERNET_CONNECTION* out
    Fiddle::TYPE_VOIDP,  # lpszConnectionName : LPSTR optional, out
    -Fiddle::TYPE_INT,  # dwNameLen : DWORD
    -Fiddle::TYPE_INT,  # dwReserved : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "wininet")]
extern "system" {
    fn InternetGetConnectedStateEx(
        lpdwFlags: *mut u32,  // INTERNET_CONNECTION* out
        lpszConnectionName: *mut u8,  // LPSTR optional, out
        dwNameLen: 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.Ansi, SetLastError = true)]
public static extern bool InternetGetConnectedStateEx(out uint lpdwFlags, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszConnectionName, uint dwNameLen, uint dwReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetGetConnectedStateEx' -Namespace Win32 -PassThru
# $api::InternetGetConnectedStateEx(lpdwFlags, lpszConnectionName, dwNameLen, dwReserved)

#uselib "WININET.dll"
#func global InternetGetConnectedStateEx "InternetGetConnectedStateEx" sptr, sptr, sptr, sptr
; InternetGetConnectedStateEx varptr(lpdwFlags), varptr(lpszConnectionName), dwNameLen, dwReserved   ; 戻り値は stat
; lpdwFlags : INTERNET_CONNECTION* out -> "sptr"
; lpszConnectionName : LPSTR optional, out -> "sptr"
; dwNameLen : DWORD -> "sptr"
; dwReserved : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WININET.dll"
#cfunc global InternetGetConnectedStateEx "InternetGetConnectedStateEx" var, var, int, int
; res = InternetGetConnectedStateEx(lpdwFlags, lpszConnectionName, dwNameLen, dwReserved)
; lpdwFlags : INTERNET_CONNECTION* out -> "var"
; lpszConnectionName : LPSTR optional, out -> "var"
; dwNameLen : DWORD -> "int"
; dwReserved : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WININET.dll"
#cfunc global InternetGetConnectedStateEx "InternetGetConnectedStateEx" sptr, sptr, int, int
; res = InternetGetConnectedStateEx(varptr(lpdwFlags), varptr(lpszConnectionName), dwNameLen, dwReserved)
; lpdwFlags : INTERNET_CONNECTION* out -> "sptr"
; lpszConnectionName : LPSTR optional, out -> "sptr"
; dwNameLen : DWORD -> "int"
; dwReserved : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。