RSOP_IEConnectionDialUpSettings class

  • Article

Contains the details of a phone-book entry for connecting to the Internet.

RSOP_IEConnectionDialUpSettings corresponds to the RASENTRY structure. For more information about valid values for various properties of this class, see RASENTRY.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[AMENDMENT]
class RSOP_IEConnectionDialUpSettings
{
  string rsopID;
  uint32 rsopPrecedence;
  string connectionName;
  string alternatePhoneNumbers;
  uint32 alternateOffset;
  string areaCode;
  string autoDialDll;
  string autoDialFunction;
  uint32 channels;
  uint32 countryCode;
  uint32 countryID;
  uint32 customAuthenticationKey;
  string customDialDll;
  string deviceName;
  string deviceType;
  uint32 dialExtraPercent;
  uint32 dialExtraSampleSeconds;
  uint32 dialMode;
  uint32 encryptionType;
  uint32 frameSize;
  uint32 framingProtocol;
  string guidID;
  uint32 hangUpExtraPercent;
  uint32 hangUpExtraSampleSeconds;
  uint32 idleDisconnectSeconds;
  string ipAddress;
  string ipDNSAddress;
  string ipDNSAddressAlternate;
  string ipWINSAddress;
  string ipWINSAddressAlternate;
  string localPhoneNumber;
  uint32 netProtocols;
  uint32 options;
  uint32 options2;
  uint32 options3;
  uint8  rasEntryData[];
  uint32 rasEntryDataSize;
  uint32 reserved1;
  uint32 reserved2;
  string scriptFile;
  uint32 subEntries;
  uint32 type;
  sint32 vpnStrategy;
  uint32 windowsVersion;
  string x25Address;
  string x25Facilities;
  string x25PadType;
  string x25UserData;
};

Members

The RSOP_IEConnectionDialUpSettings class has these types of members:

Properties

The RSOP_IEConnectionDialUpSettings class has these properties.

alternateOffset

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Alternate Offset")

Offset, in bytes, from the beginning of the associated RASENTRY structure to a list of consecutive null-terminated strings. The last string is terminated by two consecutive null characters. The strings are alternate phone numbers that RAS dials when the primary number specified by the localPhoneNumber property fails to connect. RAS dials the alternate numbers consecutively, in the order in which they are listed.

alternatePhoneNumbers

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Alternate Phone Numbers")

Alternate phone numbers to use for an Internet connection when a connection cannot be made using the primary phone number specified by the localPhoneNumber property.

areaCode

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Area Code")

Area code portion of the phone number.

autoDialDll

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Auto Dial Dll")

Full path and file name of the DLL for the customized AutoDial handler.

autoDialFunction

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Auto Dial Function")

Name of the exported RASADFunc function for the customized AutoDial handler.

channels

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Channels")

Reserved for future use.

connectionName

Data type: string

Access type: Read-only

Qualifiers: key, DisplayName ("Connection Name")

Unique name of a phone-book entry that specifies settings through which an Internet connection can be obtained.

countryCode

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Country Code")

Country/region code portion of the phone number.

countryID

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Country ID")

TAPI country/region identifier.

customAuthenticationKey

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Custom Authentication Key")

Custom authentication key provided to the Extensible Authentication Protocol (EAP) vendor.

customDialDll

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Custom Dial Dll")

Path to the filename for the DLL that implements the custom-dialing functions.

deviceName

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Device Name")

TAPI device to use with this phone-book entry.

deviceType

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Device Type")

Device type referenced by the deviceName property. See RASENTRY for a description of device types.

dialExtraPercent

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Dial Extra Percent")

A percentage of the total bandwidth available from the currently connected subentries. RAS dials an additional subentry when the total bandwidth used exceeds dialExtraPercent percent of the available bandwidth for at least dialExtraSampleSeconds seconds.

dialExtraSampleSeconds

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Dial Extra Sample Seconds")

Number of seconds that current bandwidth usage must exceed the threshold specified by the dialExtraPercent property before RAS dials an additional subentry.

dialMode

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Dial Mode")

Dial mode that specifies whether RAS dials all of the entry's multilink subentries when the entry is first connected. See RASENTRY for a list of dial modes.

encryptionType

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Encryption Type")

Encryption type to use for Microsoft Point-to-Point Encryption (MPPE) with the connection. See RASENTRY for a list of encryption types.

frameSize

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Frame Size")

Network protocol frame size.

framingProtocol

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Framing Protocol")

Framing protocol used by the server. See RASENTRY for a list of framing protocols.

guidID

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("GUID ID")

The GUID that represents this phone-book entry.

hangUpExtraPercent

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Hang Up Extra Percent")

Percent of the total bandwidth available from currently connected subentries. RAS terminates an existing subentry connection when total bandwidth used is less than hangUpExtraPercent percent of the available bandwidth for at least hangUpExtraSampleSeconds seconds.

hangUpExtraSampleSeconds

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Hang Up Extra Sample Seconds")

Number of seconds that current bandwidth usage must be less than the threshold specified by hangUpExtraPercent before RAS terminates an existing subentry connection.

idleDisconnectSeconds

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Idle Disconnect Seconds")

Number of seconds after which the connection is terminated due to inactivity.

ipAddress

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("IP Address")

IP address to use while the connection is active.

ipDNSAddress

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("IP DNS Address")

IP address of the DNS server to use while the connection is active.

ipDNSAddressAlternate

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("IP DNS Address Alternate")

IP address of the secondary or backup DNS server to use while the connection is active.

ipWINSAddress

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("IP WINS Address")

IP address of the WINS server to use while the connection is active.

ipWINSAddressAlternate

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("IP WINS Address Alternate")

IP address of the secondary or backup WINS server to use while the connection is active.

localPhoneNumber

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Local Phone Number")

Primary phone number to use for an Internet connection. For an explanation of the way RAS uses this string, see RASENTRY.

netProtocols

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Net Protocols")

Network protocols to negotiate. See RASENTRY for a list of network protocols.

options

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Options")

A set of bit flags that represents various dial-up options. See RASENTRY for details about these options.

options2

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Options 2")

A set of bit flags representing various connection options. See RASENTRY for details about these options.

options3

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Options 3")

Reserved for future use.

rasEntryData

Data type: uint8 array

Access type: Read-only

Qualifiers: DisplayName ("RAS Entry Data")

Array that contains RAS phone-book entry data. This is a RASENTRY structure that contains the connection settings for this connection name.

rasEntryDataSize

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("RAS Entry Data Size")

Size of the array, in bytes, specified by the rasEntryData property.

reserved1

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Reserved Field #1")

Reserved.

reserved2

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Reserved Field #2")

Reserved.

rsopID

Data type: string

Access type: Read-only

Qualifiers: key, DisplayName ("RSOP ID")

Foreign key to RSOP_PolicySetting.

rsopPrecedence

Data type: uint32

Access type: Read-only

Qualifiers: key, DisplayName ("RSOP Precedence")

Foreign key to RSOP_PolicySetting.

scriptFile

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Script File")

Name of the script file.

subEntries

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Sub-Entries")

Number of multilink subentries associated with this phone-book entry.

type

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Type")

Type of phone-book entry. See RASENTRY for a list of types.

vpnStrategy

Data type: sint32

Access type: Read-only

Qualifiers: DisplayName ("VPN Strategy")

The VPN strategy to use when dialing a VPN connection. See RASENTRY for a list of strategies.

windowsVersion

Data type: uint32

Access type: Read-only

Qualifiers: DisplayName ("Windows Version")

Version of Windows in which the process is running.

x25Address

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("X25 Address")

Identifies the X.25 address to which to connect.

x25Facilities

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("X25 Facilities")

The facilities to request from the X.25 host at connection.

x25PadType

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("X25 Pad Type")

The X.25 pad type.

x25UserData

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("X25 User Data")

Additional connection information supplied to the X.25 host at connection.

Requirements
Minimum supported client
 Windows Vista
Minimum supported server
 Windows Server 2008
Namespace
 Root\RSOP\Computer, Root\RSOP\User
MOF
Rsop.mof
DLL
GPSvc.dll

See also

RSOP_PolicySetting

RSOP_IEConnectionDialUpSettingsLink

RASENTRY

RSOP_IEConnectionDialUpCredentials

RASADFunc