InternetGetConnectedState Function

InternetGetConnectedState Function

Retrieves the connected state of the local system.

Syntax

C++

BOOL InternetGetConnectedState(
  __out  LPDWORD lpdwFlags,
  __in   DWORD dwReserved
);

Parameters

lpdwFlags [out]

Pointer to a variable that receives the connection description. This parameter may return a valid flag even when the function returns FALSE. This parameter can be one or more of the following values.

Value	Meaning
INTERNET_CONNECTION_CONFIGURED 0x40	Local system has a valid connection to the Internet, but it might or might not be currently connected.
INTERNET_CONNECTION_LAN 0x02	Local system uses a local area network to connect to the Internet.
INTERNET_CONNECTION_MODEM 0x01	Local system uses a modem to connect to the Internet.
INTERNET_CONNECTION_MODEM_BUSY 0x08	No longer used.
INTERNET_CONNECTION_OFFLINE 0x20	Local system is in offline mode.
INTERNET_CONNECTION_PROXY 0x04	Local system uses a proxy server to connect to the Internet.

dwReserved [in]

This parameter is reserved and must be 0.

Return Value

Returns TRUE if there is an active modem or a LAN Internet connection, or FALSE if there is no Internet connection, or if all possible Internet connections are not currently active. For more information, see the Remarks section.

When InternetGetConnectedState returns FALSE, the application can call GetLastError to retrieve the error code.

Remarks

A return value of TRUE from InternetGetConnectedState indicates that at least one connection to the Internet is available. It does not guarantee that a connection to a specific host can be established. Applications should always check for errors returned from API calls that connect to a server. InternetCheckConnection can be called to determine if a connection to a specific destination can be established.

A return value of TRUE indicates that either the modem connection is active, or a LAN connection is active and a proxy is properly configured for the LAN. A return value of FALSE indicates that neither the modem nor the LAN is connected. If FALSE is returned, the INTERNET_CONNECTION_CONFIGURED flag may be set to indicate that autodial is configured to "always dial" but is not currently active. If autodial is not configured, the function returns FALSE.

Requirements

Minimum supported client	Windows 2000 Professional
Minimum supported server	Windows 2000 Server
Version	Internet Explorer 4.0 or later
Header	Wininet.h
Library	Wininet.lib
DLL	Wininet.dll

See Also

Establishing a Dial-Up Connection to the Internet

WinINet Functions

Send comments about this topic to Microsoft

Build date: 3/12/2009