Compartilhar via


RASCONNSTATUS structure

The RASCONNSTATUS structure describes the current status of a remote access connection. It is returned by the RasGetConnectStatus function.

Syntax

typedef struct _RASCONNSTATUS {
  DWORD             dwSize;
  RASCONNSTATE      rasconnstate;
  DWORD             dwError;
  TCHAR             szDeviceType[RAS_MaxDeviceType + 1];
  TCHAR             szDeviceName[RAS_MaxDeviceName + 1];
  TCHAR             szPhoneNumber[RAS_MaxPhoneNumber + 1];
  RASTUNNELENDPOINT  localEndPoint;
  RASTUNNELENDPOINT  remoteEndPoint;
  RASCONNSUBSTATE    rasconnsubstate;
} RASCONNSTATUS;

Members

  • dwSize
    Specifies the structure size, in bytes.

  • rasconnstate
    Specifies a RASCONNSTATE enumerator value that indicates the current state of the RasDial connection process; that is, the piece of the RasDial process that is currently executing.

    Two state values are especially significant.

    State Meaning
    RASCS_Connected Indicates that the connection has been successfully established.
    RASCS_Disconnected Indicates that the connection has failed.

     

  • dwError
    If nonzero, indicates the reason for failure. The value is one of the error values from the RasError.h header file or one of ERROR_NOT_ENOUGH_MEMORY or ERROR_INVALID_HANDLE.

  • szDeviceType
    A string that specifies the type of the current device, if available. For example, common device types supported by RAS are "modem", "pad", "switch", "ISDN", or "null". See RASENTRY for a complete list of possible device types.

  • szDeviceName
    A string that specifies the name of the current device, if available. This would be the name of the modem — for example, "Hayes SmartModem 2400"; the name of the PAD, for example "US Sprint"; or the name of a switch device, for example "Racal-Guardata".

  • szPhoneNumber
    A string that indicates the phone number dialed for this specific connection.

  • localEndPoint
    A RASTUNNELENDPOINT structure that contains the local client endpoint information of a virtual private network (VPN) endpoint.

    Note  Supported in Windows 7 and later versions of Windows.

     

  • remoteEndPoint
    A RASTUNNELENDPOINT structure that contains the remote server endpoint information of a virtual private network (VPN) endpoint.

    Note  Supported in Windows 7 and later versions of Windows.

     

  • rasconnsubstate
    A RASCONNSUBSTATE enumeration that specifies state information of an Internet Key Exchange version 2 (IKEv2) VPN tunnel.

    Note  Supported in Windows 7 and later versions of Windows.

     

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Ras.h

Unicode and ANSI names

RASCONNSTATUSW (Unicode) and RASCONNSTATUSA (ANSI)

See also

Remote Access Service (RAS) Overview

Remote Access Service Structures

RasGetConnectStatus

RasDial

RASCONNSTATE