Click to Rate and Give Feedback
MSDN
MSDN Library
Networking
Network Management
SENS Reference

  Switch on low bandwidth view
IsDestinationReachable Function

The IsDestinationReachable function determines whether or not a specified destination can be reached, and provides Quality of Connection (QOC) information for a destination.

Windows Vista and later, Windows Server 2008 and later:  This function is not supported and always returns ERROR_CALL_NOT_IMPLEMENTED.

Syntax

C++
BOOL IsDestinationReachable(
  __in     LPCSTR lpszDestination,
  __inout  LPQOCINFO lpQOCInfo
);

Parameters

lpszDestination [in]

A pointer to a null-terminated string that specifies a destination. The destination can be an IP address, UNC name, or URL.

lpQOCInfo [in, out]

A pointer to the QOCINFO structure that receives the Quality of Connection (QOC) information. You can supply a NULL pointer if you do not want to receive the QOC information.

Return Value

Return codeDescription
TRUE

A destination can be reached.

FALSE

A destination cannot be reached. To get extended error information, call GetLastError.

ERROR_CALL_NOT_IMPLEMENTED

This function is not available on Windows Vista.

 

Remarks

Client applications use this function to determine the QOC information before proceeding with network operations. For standalone computers that are directly connected to a network through a network card or remote access server (RAS), this function generates minimal network traffic with RPC calls to the nearest router. For computers that are part of a network where a destination can be reached by using RAS or a network gateway, this function pings a destination to generate accurate QOC information.

This function is only available for TCP/IP connections. A caller supplies the buffer for the QOCINFO structure, and must release the memory when it is not needed.

Requirements

Minimum supported clientWindows 2000 Professional
Minimum supported serverWindows 2000 Server
End of client supportWindows XP
End of server supportWindows Server 2003
HeaderSensapi.h
LibrarySensapi.lib
DLLSensapi.dll
Unicode and ANSI namesIsDestinationReachableW (Unicode) and IsDestinationReachableA (ANSI)

See Also

About System Event Notification Service
IsNetworkAlive
QOCINFO

Send comments about this topic to Microsoft

Build date: 6/4/2009

Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Alternatives on Vista?      F. Stanchina   |   Edit   |   Show History
Please add remarks describing possible alternatives on Windows Vista and later.
Tags What's this?: Add a tag
Flag as ContentBug
Processing
© 2009 Microsoft Corporation. All rights reserved. Terms of Use  |  Trademarks  |  Privacy Statement
Page view tracker