Important: |
---|
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist. |
This structure describes the current status of a remote access connection. It is returned by the RasGetConnectStatusfunction.
Syntax
typedef struct _RASCONNSTATUS { DWORD dwSize; RASCONNSTATE rasconnstate; DWORD dwError; TCHAR szDeviceType[ RAS_MaxDeviceType + 1 ]; TCHAR szDeviceName[ RAS_MaxDeviceName + 1 ]; } RASCONNSTATUS; |
Members
- dwSize
-
Specifies the structure size, in bytes.
- rasconnstate
-
Specifies a RASCONNSTATEenumerator value that indicates the current state of the RasDialconnection process; that is, the piece of the RasDialprocess that is currently executing.
The following table shows the two state values that are especially significant.
Value Description RASCS_Connected
Indicates that the connection has been successfully established.
RASCS_Disconnected
Indicates that the connection has failed.
- dwError
-
If nonzero, specifies the reason for failure. The value is one of the error values from the RAS header file or one of ERROR_NOT_ENOUGH_MEMORY or ERROR_INVALID_HANDLE.
- szDeviceType
-
Null-terminated string that specifies the type of the current device, if available. For example, common device types supported by RAS are modem, pad, switch, isdn, and NULL.
- szDeviceName
-
Null-terminated 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.
Requirements
Header | ras.h |
Windows Embedded CE | Windows CE 1.0 and later |
Windows Mobile | Windows Mobile Version 5.0 and later |