The RASENTRY structure describes a phone-book entry. The RasSetEntryProperties and RasGetEntryProperties functions use this structure to set and retrieve the properties of a phone-book entry.
typedef struct tagRASENTRY {
DWORD dwSize;
DWORD dwfOptions;
//
// Location/phone number.
//
DWORD dwCountryID;
DWORD dwCountryCode;
TCHAR szAreaCode[ RAS_MaxAreaCode + 1 ];
TCHAR szLocalPhoneNumber[ RAS_MaxPhoneNumber + 1 ];
DWORD dwAlternateOffset;
//
// PPP/Ip
//
RASIPADDR ipaddr;
RASIPADDR ipaddrDns;
RASIPADDR ipaddrDnsAlt;
RASIPADDR ipaddrWins;
RASIPADDR ipaddrWinsAlt;
//
// Framing
//
DWORD dwFrameSize;
DWORD dwfNetProtocols;
DWORD dwFramingProtocol;
//
// Scripting
//
TCHAR szScript[ MAX_PATH ];
//
// AutoDial
//
TCHAR szAutodialDll[ MAX_PATH ];
TCHAR szAutodialFunc[ MAX_PATH ];
//
// Device
//
TCHAR szDeviceType[ RAS_MaxDeviceType + 1 ];
TCHAR szDeviceName[ RAS_MaxDeviceName + 1 ];
//
// X.25
//
TCHAR szX25PadType[ RAS_MaxPadType + 1 ];
TCHAR szX25Address[ RAS_MaxX25Address + 1 ];
TCHAR szX25Facilities[ RAS_MaxFacilities + 1 ];
TCHAR szX25UserData[ RAS_MaxUserData + 1 ];
DWORD dwChannels;
//
// Reserved
//
DWORD dwReserved1;
DWORD dwReserved2;
#if (WINVER >= 0x401)
//
// Multilink
//
DWORD dwSubEntries;
DWORD dwDialMode;
DWORD dwDialExtraPercent;
DWORD dwDialExtraSampleSeconds;
DWORD dwHangUpExtraPercent;
DWORD dwHangUpExtraSampleSeconds;
//
// Idle timeout
//
DWORD dwIdleDisconnectSeconds;
#endif
} RASENTRY;
|
Flag |
Description |
|
RASEO_UseCountryAndAreaCodes |
If this flag is set, the dwCountryID, dwCountryCode, and szAreaCode members are used to construct the phone number. If this flag is not set, these members are ignored. This flag corresponds to the Use Country and Area Codes check box in the Phone dialog box. |
|
RASEO_SpecificIpAddr |
If this flag is set, RAS tries to use the IP address specified by ipaddr as the IP address for the dial-up connection. If this flag is not set, the value of the ipaddr member is ignored. Setting the RASEO_SpecificIpAddr flag corresponds to selecting the Specify an IP Address setting in the TCP/IP settings dialog box. Clearing the RASEO_SpecificIpAddr flag corresponds to selecting the Server Assigned IP Address setting in the TCP/IP settings dialog box. Currently, an IP address set in the phone-book entry properties or retrieved from a server overrides the IP address set in the network control panel. |
|
RASEO_SpecificNameServers |
If this flag is set, RAS uses the ipaddrDns, ipaddrDnsAlt, ipaddrWins, and ipaddrWinsAlt members to specify the name server addresses for the dial-up connection. If this flag is not set, RAS ignores these members. Setting the RASEO_SpecificNameServers flag corresponds to selecting the Specify Name Server Addresses setting in the TCP/IP Settings dialog box. Clearing the RASEO_SpecificNameServers flag corresponds to selecting the Server Assigned Name Server Addresses setting in the TCP/IP Settings dialog box. |
|
RASEO_IpHeaderCompression |
If this flag is set, RAS negotiates to use IP header compression on PPP connections. If this flag is not set, IP header compression is not negotiated. This flag corresponds to the Use IP Header Compression check box in the TCP/IP settings dialog box. It is generally advisable to set this flag because IP header compression significantly improves performance. The flag should be cleared only when connecting to a server that does not correctly negotiate IP header compression. |
|
RASEO_RemoteDefaultGateway |
If this flag is set, the default route for IP packets is through the dial-up adapter when the connection is active. If this flag is clear, the default route is not modified. This flag corresponds to the Use Default Gateway on Remote Network check box in the TCP/IP settings dialog box. |
|
RASEO_DisableLcpExtensions |
If this flag is set, RAS disables the PPP LCP extensions defined in RFC 1570. This may be necessary to connect to certain older PPP implementations, but interferes with features such as server callback. Do not set this flag unless specifically required. |
|
RASEO_TerminalBeforeDial |
If this flag is set, RAS displays a terminal window for user input before dialing the connection. |
|
RASEO_TerminalAfterDial |
If this flag is set, RAS displays a terminal window for user input after dialing the connection. Do not set this flag if a dial-up networking script is to be associated with the connection, because scripting has its own terminal implementation. |
|
RASEO_ModemLights |
This flag is currently ignored. |
|
RASEO_SwCompression |
If this flag is set, software compression is negotiated on the link. Setting this flag causes the PPP driver to attempt to negotiate CCP with the server. This flag should be set by default, but clearing it can reduce the negotiation period if the server does not support a compatible compression protocol. |
|
RASEO_RequireEncryptedPw |
If this flag is set, only secure password schemes can be used to authenticate the client with the server. This prevents the PPP driver from using the PAP plain-text authentication protocol to authenticate the client. The CHAP and SPAP authentication protocols are also supported. Clear this flag for increased interoperability, and set it for increased security. This flag corresponds to the Require Encrypted Password check box in the Security dialog box. See also RASEO_RequireMsEncryptedPw. |
|
RASEO_RequireMsEncryptedPw |
If this flag is set, only Microsofts secure password schemes can be used to authenticate the client with the server. This prevents the PPP driver from using the PPP plain-text authentication protocol, MD5-CHAP, MS-CHAP, or SPAP. The flag should be cleared for maximum interoperability and should be set for maximum security. This flag takes precedence over RASEO_RequireEncryptedPw. This flag corresponds to the Require Microsoft Encrypted Password check box in the Security dialog box. See also RASEO_RequireDataEncryption. |
|
RASEO_RequireDataEncryption |
If this flag is set, data encryption must be negotiated successfully or the connection should be dropped. This flag is ignored unless RASEO_RequireMsEncryptedPw is also set. This flag corresponds to the Require Data Encryption check box in the Security dialog box. |
|
RASEO_NetworkLogon |
If this flag is set, RAS logs on to the network after the point-to-point connection is established. This flag currently has no effect under Windows NT. |
|
RASEO_UseLogonCredentials |
If this flag is set, RAS uses the user name, password, and domain of the currently logged-on user when dialing this entry. This flag is ignored unless RASEO_RequireMsEncryptedPw is also set. Note that this setting is ignored by the RasDial function, where specifying empty strings for the szUserName and szPassword members of the RASDIALPARAMS structure gives the same result. This flag corresponds to the Use Current Username and Password check box in the Security dialog box. |
|
RASEO_PromoteAlternates |
This flag has an effect when alternate phone numbers are defined by the dwAlternateOffset member. If this flag is set, an alternate phone number that connects successfully becomes the primary phone number, and the current primary phone number is moved to the alternate list. This flag corresponds to the check box in the Alternate Numbers dialog box. |
|
RASEO_SecureLocalFiles |
Windows NT only: If this flag is set, RAS checks for existing remote file system and remote printer bindings before making a connection with this entry. Typically, you set this flag on phone-book entries for public networks to remind users to break connections to their private network before connecting to a public network. |
|
Flag |
Description |
|
RASNP_NetBEUI |
Negotiate the NetBEUI protocol. |
|
RASNP_Ipx |
Negotiate the IPX protocol. |
|
RASNP_Ip |
Negotiate the TCP/IP protocol. |
|
Flag |
Description |
|
RASFP_Ppp |
Point-to-Point Protocol (PPP) |
|
RASFP_Slip |
Serial Line Internet Protocol (SLIP) |
|
RASFP_Ras |
Microsoft proprietary protocol implemented in Windows NT 3.1 and Windows for Workgroups 3.11 |
To use Compressed SLIP, set the RASFP_Slip flag and set the
RASEO_IpHeaderCompression flag in the dwfOptions member.
Windows NT: To indicate a Windows NT SWITCH.INF script name, set the
first character of the name to [.
|
String |
Description |
|
RASDT_Modem |
A modem accessed through a COM port. |
|
RASDT_Isdn |
An ISDN card with corresponding NDISWAN driver installed. |
|
RASDT_X25 |
An X.25 card with corresponding NDISWAN driver installed. |
Windows NT: Under Windows NT, the szX25PadType string maps to a
section name in PAD.INF.
dwChannels;
|
Value |
Meaning |
|
RASEDM_DialAll |
Dial all subentries initially. |
|
RASEDM_DialAsNeeded |
Adjust the number of subentries as bandwidth is needed. RAS uses the dwDialExtraPercent, dwDialExtraSampleSeconds, dwDialHangUpExtraPercent, and dwHangUpExtraSampleSeconds members to determine when to dial or disconnect a subentry. |
This member is ignored unless the dwDialMode member specifies the
RASEDM_DialAsNeeded flag.
This member is ignored unless the dwDialMode member specifies the
RASEDM_DialAsNeeded flag.
This member is ignored unless the dwDialMode member specifies the
RASEDM_DialAsNeeded flag.
This member is ignored unless the dwDialMode member specifies the
RASEDM_DialAsNeeded flag.
|
Value |
Meaning |
|
RASIDS_Disabled |
There is no idle timeout for this connection. |
|
RASIDS_UseGlobalValue |
Use the user preference value as the default. |
RASADFunc, RasGetCountryInfo, RasSetEntryProperties, RasSetSubEntryProperties