InternetCheckConnection Function

Allows an application to check if a connection to the Internet can be established.

Syntax

BOOL InternetCheckConnection%(
    IN LPCTSTR% lpszUrl,
    IN DWORD dwFlags,
    IN DWORD dwReserved
);

The actual syntax of this function varies between its ANSI and Unicode implementations. See the Win32 Internet Functions Syntax document for details.

Parameters

lpszUrl

Address of a string containing the Uniform Resource Locator (URL) to use to check the connection. This value can be set to NULL.

dwFlags

Unsigned long integer value containing the flag values. FLAG_ICC_FORCE_CONNECTION is the only flag that is currently available. If this flag is set, it forces a connection. A sockets connection is attempted in the following order:

• If lpszUrl is non-NULL, the host value is extracted from it and used to ping that specific host.
• If lpszUrl is NULL and there is an entry in WinInet's internal server database for the nearest sever, the host value is extracted from the entry and used to ping that server.

dwReserved

Reserved. Must be set to zero.

Return Value

Returns TRUE if a connection is made successfully, or FALSE otherwise. Use GetLastError to retrieve the error code. ERROR_NOT_CONNECTED is returned by GetLastError if a connection cannot be made or if the sockets database is unconditionally offline.

Function Information

Windows NT	Use version 4.0 and later. Implemented as ANSI and Unicode functions.
Windows	Use Windows 95 and later. Implemented as ANSI and Unicode functions.
Header	Wininet.h
Import library	Wininet.lib
Minimum availability	Internet Explorer 3.0 (ANSI only), 5 (ANSI and Unicode)

See Also

Microsoft Win32 Internet Functions Overview, Enabling Internet Functionality, Microsoft Win32 Internet Functions Reference, General Win32 Internet Functions

Does this content meet your programming needs? Write us!

Back to top