RASCONNSTATUS
A version of this page is also available for
4/8/2010
This 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 ];
} 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.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 |