DotRas SDK Documentation

DotRas SDK

Welcome
Getting Started
Choosing Your Build
Version History
Version 1.0.0.0
Version 1.1.0.0
Version 1.2.0.0
Version 1.3.0.0
Making a Donation
DotRas API Reference
DotRas Namespace
CredentialPromptDialog Class
CredentialPromptDialog Members
CredentialPromptDialog Constructor
CredentialPromptDialog Constructor
CredentialPromptDialog Constructor (IContainer)
CredentialPromptDialog Methods
Reset Method
CredentialPromptDialog Properties
Caption Property
DisableUserName Property
MaxPasswordLength Property
MaxUserNameLength Property
Message Property
NotifyIncorrectPassword Property
Password Property
SaveChecked Property
ShowSaveCheckBox Property
TargetName Property
UserName Property
CredentialPromptDialog Events
DialCompletedEventArgs Class
DialCompletedEventArgs Members
DialCompletedEventArgs Constructor
DialCompletedEventArgs Methods
DialCompletedEventArgs Properties
Connected Property
Handle Property
TimedOut Property
InvalidHandleException Class
InvalidHandleException Members
InvalidHandleException Constructor
InvalidHandleException Constructor
InvalidHandleException Constructor (String)
InvalidHandleException Constructor (RasHandle)
InvalidHandleException Constructor (SerializationInfo, StreamingContext)
InvalidHandleException Constructor (String, Exception)
InvalidHandleException Constructor (RasHandle, String)
InvalidHandleException Constructor (RasHandle, String, Exception)
InvalidHandleException Methods
GetObjectData Method
InvalidHandleException Properties
Handle Property
InvalidHandleException Events
Luid Structure
Luid Members
Luid Constructor
Luid Fields
Empty Field
Luid Methods
Equals Method
Equals Method (Object)
Equals Method (Luid)
GetHashCode Method
NewLuid Method
ToString Method
ToString Method
ToString Method (String)
ToString Method (String, IFormatProvider)
Luid Operators
Equality Operator
Inequality Operator
RasAmbInfo Class
RasAmbInfo Members
RasAmbInfo Methods
RasAmbInfo Properties
ErrorCode Property
Lana Property
NetBiosErrorMessage Property
RasAutoDialAddress Class
RasAutoDialAddress Members
RasAutoDialAddress Constructor
RasAutoDialAddress Methods
RasAutoDialAddress Properties
Address Property
Entries Property
RasAutoDialAddressCollection Class
RasAutoDialAddressCollection Members
RasAutoDialAddressCollection Methods
RasAutoDialAddressCollection Properties
Item Property
Item Property (String)
RasAutoDialEntry Class
RasAutoDialEntry Members
RasAutoDialEntry Constructor
RasAutoDialEntry Constructor
RasAutoDialEntry Constructor (Int32, String)
RasAutoDialEntry Methods
RasAutoDialEntry Properties
DialingLocation Property
EntryName Property
RasAutoDialManager Class
RasAutoDialManager Members
RasAutoDialManager Constructor
RasAutoDialManager Constructor
RasAutoDialManager Constructor (IContainer)
RasAutoDialManager Methods
IsAutoDialEnabled Method
UpdateAutoDialStatus Method
RasAutoDialManager Properties
Addresses Property
ConnectionQueryTimeout Property
DisableConnectionQuery Property
FailedConnectionTimeout Property
LogOnSessionDisable Property
SavedAddressesLimit Property
RasAutoDialManager Events
RasCcpInfo Class
RasCcpInfo Members
RasCcpInfo Methods
RasCcpInfo Properties
CompressionAlgorithm Property
ErrorCode Property
Options Property
ServerCompressionAlgorithm Property
ServerOptions Property
RasCompressionOptions Class
RasCompressionOptions Members
RasCompressionOptions Methods
Clone Method
RasCompressionOptions Properties
CompressionOnly Property
Encryption128Bit Property
Encryption40Bit Property
Encryption56Bit Property
HistoryLess Property
RasCompressionType Enumeration
RasConnection Class
RasConnection Members
RasConnection Methods
ClearConnectionStatistics Method
ClearLinkStatistics Method
GetActiveConnectionByHandle Method
GetActiveConnectionById Method
GetActiveConnectionByName Method
GetActiveConnectionByName Method (String, String)
GetActiveConnectionByName Method (String, String, StringComparison)
GetActiveConnections Method
GetConnectionStatistics Method
GetConnectionStatus Method
GetLinkStatistics Method
GetNapStatus Method
GetProjectionInfo Method
GetSubEntryHandle Method
HangUp Method
HangUp Method
HangUp Method (Boolean)
HangUp Method (Int32)
HangUp Method (Int32, Boolean)
UpdateConnection Method
RasConnection Properties
ConnectionOptions Property
CorrelationId Property
Device Property
EntryId Property
EntryName Property
Handle Property
PhoneBookPath Property
SessionId Property
SubEntryId Property
RasConnectionEventArgs Class
RasConnectionEventArgs Members
RasConnectionEventArgs Constructor
RasConnectionEventArgs Methods
RasConnectionEventArgs Properties
Connection Property
RasConnectionOptions Class
RasConnectionOptions Members
RasConnectionOptions Methods
RasConnectionOptions Properties
AllUsers Property
GlobalCredentials Property
OwnerKnown Property
OwnerMatch Property
RasConnectionState Enumeration
RasConnectionStatus Class
RasConnectionStatus Members
RasConnectionStatus Methods
RasConnectionStatus Properties
ConnectionState Property
ConnectionSubState Property
Device Property
ErrorCode Property
ErrorMessage Property
LocalEndPoint Property
PhoneNumber Property
RemoteEndPoint Property
RasConnectionSubState Enumeration
RasConnectionWatcher Class
RasConnectionWatcher Members
RasConnectionWatcher Constructor
RasConnectionWatcher Constructor
RasConnectionWatcher Constructor (IContainer)
RasConnectionWatcher Methods
BeginInit Method
EndInit Method
RasConnectionWatcher Properties
EnableRaisingEvents Property
Handle Property
RasConnectionWatcher Events
BandwidthAdded Event
BandwidthRemoved Event
Connected Event
Disconnected Event
RasCountry Class
RasCountry Members
RasCountry Methods
GetCountries Method
GetCountryById Method
ToString Method
RasCountry Properties
Code Property
Id Property
Name Property
RasDevice Class
RasDevice Members
RasDevice Methods
Create Method
GetDeviceByName Method
GetDeviceByName Method (String, RasDeviceType)
GetDeviceByName Method (String, RasDeviceType, Boolean)
GetDevices Method
GetDevicesByType Method
RasDevice Properties
DeviceType Property
Name Property
RasDeviceType Enumeration
RasDeviceTypeConverter Class
RasDeviceTypeConverter Members
RasDeviceTypeConverter Constructor
RasDeviceTypeConverter Methods
CanConvertFrom Method
CanConvertFrom Method (ITypeDescriptorContext, Type)
CanConvertTo Method
CanConvertTo Method (ITypeDescriptorContext, Type)
ConvertFrom Method
ConvertFrom Method (ITypeDescriptorContext, CultureInfo, Object)
ConvertTo Method
ConvertTo Method (ITypeDescriptorContext, CultureInfo, Object, Type)
RasDialDialog Class
RasDialDialog Members
RasDialDialog Constructor
RasDialDialog Methods
Reset Method
RasDialDialog Properties
EntryName Property
PhoneBookPath Property
PhoneNumber Property
SubEntryId Property
RasDialDialog Events
RasDialer Class
RasDialer Members
RasDialer Constructor
RasDialer Constructor
RasDialer Constructor (IContainer)
RasDialer Methods
Dial Method
DialAsync Method
DialAsyncCancel Method
SetEapUserData Method
RasDialer Properties
AllowUseStoredCredentials Property
AuthenticationCookie Property
AutoUpdateCredentials Property
CallbackId Property
CallbackNumber Property
Credentials Property
EapOptions Property
EntryName Property
HangUpPollingInterval Property
InterfaceIndex Property
IsBusy Property
Options Property
Owner Property
PhoneBookPath Property
PhoneNumber Property
SkipPppAuthentication Property
SubEntryId Property
Timeout Property
RasDialer Events
DialCompleted Event
StateChanged Event
RasDialException Class
RasDialException Members
RasDialException Constructor
RasDialException Constructor
RasDialException Constructor (String)
RasDialException Constructor (Int32, Int32)
RasDialException Constructor (SerializationInfo, StreamingContext)
RasDialException Constructor (String, Exception)
RasDialException Methods
GetObjectData Method
RasDialException Properties
ExtendedErrorCode Property
RasDialException Events
RasDialMode Enumeration
RasDialogStyle Enumeration
RasDialOptions Class
RasDialOptions Members
RasDialOptions Constructor
RasDialOptions Constructor
RasDialOptions Constructor (Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean)
RasDialOptions Constructor (Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean)
RasDialOptions Methods
RasDialOptions Properties
CustomDial Property
DisableConnectedUI Property
DisableReconnect Property
DisableReconnectUI Property
NoUser Property
PausedStates Property
Router Property
SetModemSpeaker Property
SetSoftwareCompression Property
UseCustomScripting Property
UsePrefixSuffix Property
RasDialOptionsConverter Class
RasDialOptionsConverter Members
RasDialOptionsConverter Constructor
RasDialOptionsConverter Methods
CanConvertFrom Method
CanConvertFrom Method (ITypeDescriptorContext, Type)
CanConvertTo Method
CanConvertTo Method (ITypeDescriptorContext, Type)
ConvertFrom Method
ConvertFrom Method (ITypeDescriptorContext, CultureInfo, Object)
ConvertTo Method
ConvertTo Method (ITypeDescriptorContext, CultureInfo, Object, Type)
GetProperties Method
GetProperties Method (ITypeDescriptorContext, Object, Attribute[])
GetPropertiesSupported Method
GetPropertiesSupported Method (ITypeDescriptorContext)
RasEapOptions Class
RasEapOptions Members
RasEapOptions Constructor
RasEapOptions Constructor
RasEapOptions Constructor (Boolean, Boolean, Boolean)
RasEapOptions Methods
RasEapOptions Properties
LogOn Property
NonInteractive Property
Preview Property
RasEapOptionsConverter Class
RasEapOptionsConverter Members
RasEapOptionsConverter Constructor
RasEapOptionsConverter Methods
CanConvertFrom Method
CanConvertFrom Method (ITypeDescriptorContext, Type)
CanConvertTo Method
CanConvertTo Method (ITypeDescriptorContext, Type)
ConvertFrom Method
ConvertFrom Method (ITypeDescriptorContext, CultureInfo, Object)
ConvertTo Method
ConvertTo Method (ITypeDescriptorContext, CultureInfo, Object, Type)
GetProperties Method
GetProperties Method (ITypeDescriptorContext, Object, Attribute[])
GetPropertiesSupported Method
GetPropertiesSupported Method (ITypeDescriptorContext)
RasEncryptionType Enumeration
RasEntry Class
RasEntry Members
RasEntry Constructor
RasEntry Methods
ClearCredentials Method
ClearCredentials Method
ClearCredentials Method (RasPreSharedKey)
Clone Method
CreateBroadbandEntry Method
CreateBroadbandEntry Method (String, RasDevice)
CreateBroadbandEntry Method (String, RasDevice, Boolean)
CreateDialUpEntry Method
CreateVpnEntry Method
CreateVpnEntry Method (String, String, RasVpnStrategy, RasDevice)
CreateVpnEntry Method (String, String, RasVpnStrategy, RasDevice, Boolean)
Exists Method
GetCredentials Method
GetCredentials Method
GetCredentials Method (RasPreSharedKey)
GetCustomAuthData Method
GetEapUserData Method
Remove Method
Rename Method
Update Method
UpdateCredentials Method
UpdateCredentials Method (NetworkCredential)
UpdateCredentials Method (NetworkCredential, Boolean)
UpdateCredentials Method (RasPreSharedKey, String)
UpdateCustomAuthData Method
UpdateEapUserData Method
RasEntry Properties
AlternatePhoneNumbers Property
AreaCode Property
AutoDialDll Property
AutoDialFunc Property
Channels Property
CountryCode Property
CountryId Property
CustomAuthKey Property
CustomDialDll Property
Device Property
DialExtraPercent Property
DialExtraSampleSeconds Property
DialMode Property
DnsAddress Property
DnsAddressAlt Property
DnsSuffix Property
EncryptionType Property
EntryType Property
FrameSize Property
FramingProtocol Property
HangUpExtraPercent Property
HangUpExtraSampleSeconds Property
Id Property
IdleDisconnectSeconds Property
IPAddress Property
IPv4InterfaceMetric Property
IPv6Address Property
IPv6DnsAddress Property
IPv6DnsAddressAlt Property
IPv6InterfaceMetric Property
IPv6PrefixLength Property
Name Property
NetworkOutageTime Property
NetworkProtocols Property
Options Property
Owner Property
PhoneNumber Property
PrerequisiteEntryName Property
PrerequisitePhoneBook Property
RedialCount Property
RedialPause Property
Script Property
SubEntries Property
TcpWindowSize Property
VpnStrategy Property
WinsAddress Property
WinsAddressAlt Property
X25Address Property
X25Facilities Property
X25PadType Property
X25UserData Property
RasEntryCollection Class
RasEntryCollection Members
RasEntryCollection Methods
Contains Method
Contains Method (String)
Remove Method
Remove Method (String)
RasEntryCollection Properties
Item Property
Item Property (String)
RasEntryDialog Class
RasEntryDialog Members
RasEntryDialog Constructor
RasEntryDialog Methods
Reset Method
RasEntryDialog Properties
EntryName Property
NoRename Property
PhoneBookPath Property
Style Property
RasEntryDialog Events
RasEntryNameValidator Class
RasEntryNameValidator Members
RasEntryNameValidator Constructor
RasEntryNameValidator Methods
Validate Method
RasEntryNameValidator Properties
AllowExistingEntries Property
AllowNonExistentPhoneBook Property
EntryName Property
ErrorCode Property
ErrorMessage Property
IsValid Property
PhoneBookPath Property
RasEntryOptions Class
RasEntryOptions Members
RasEntryOptions Constructor
RasEntryOptions Methods
Clone Method
RasEntryOptions Properties
CacheCredentials Property
CustomEncryption Property
CustomScript Property
DisableClassBasedStaticRoute Property
DisableIkeNameEkuCheck Property
DisableLcpExtensions Property
DisableMobility Property
DisableNbtOverIP Property
DoNotNegotiateMultilink Property
DoNotUseRasCredentials Property
Internet Property
IPHeaderCompression Property
IPv6RemoteDefaultGateway Property
ModemLights Property
NetworkLogOn Property
PreviewDomain Property
PreviewPhoneNumber Property
PreviewUserPassword Property
PromoteAlternates Property
ReconnectIfDropped Property
RegisterIPWithDns Property
RemoteDefaultGateway Property
RequireChap Property
RequireDataEncryption Property
RequireEap Property
RequireEncryptedPassword Property
RequireMachineCertificates Property
RequireMSChap Property
RequireMSChap2 Property
RequireMSEncryptedPassword Property
RequirePap Property
RequireSpap Property
RequireWin95MSChap Property
SecureClientForMSNet Property
SecureFileAndPrint Property
SecureLocalFiles Property
SecureRoutingCompartment Property
SharedPhoneNumbers Property
SharePhoneNumbers Property
ShowDialingProgress Property
SoftwareCompression Property
TerminalAfterDial Property
TerminalBeforeDial Property
UseCountryAndAreaCodes Property
UseDnsSuffixForRegistration Property
UseGlobalDeviceSettings Property
UseLogOnCredentials Property
UsePreSharedKey Property
UsePreSharedKeyForIkeV2Initiator Property
UsePreSharedKeyForIkeV2Responder Property
UseTypicalSettings Property
RasEntryType Enumeration
RasErrorEventArgs Class
RasErrorEventArgs Members
RasErrorEventArgs Constructor
RasErrorEventArgs Methods
RasErrorEventArgs Properties
ErrorCode Property
ErrorMessage Property
RasException Class
RasException Members
RasException Constructor
RasException Constructor
RasException Constructor (Int32)
RasException Constructor (String)
RasException Constructor (SerializationInfo, StreamingContext)
RasException Constructor (String, Exception)
RasException Methods
GetObjectData Method
RasException Properties
ErrorCode Property
RasException Events
RasFramingProtocol Enumeration
RasHandle Class
RasHandle Members
RasHandle Constructor
RasHandle Methods
Equals Method
Equals Method (Object)
Equals Method (RasHandle)
GetHashCode Method
RasHandle Operators
Equality Operator
Inequality Operator
RasHandle Properties
IsMultilink Property
RasIdleDisconnectTimeout Class
RasIdleDisconnectTimeout Members
RasIdleDisconnectTimeout Fields
Default Field
Disabled Field
RasIkeV2AuthenticationType Enumeration
RasIkeV2Info Class
RasIkeV2Info Members
RasIkeV2Info Methods
RasIkeV2Info Properties
AuthenticationProtocol Property
EapTypeId Property
EncryptionMethod Property
IPv4Address Property
IPv4NegotiationErrorCode Property
IPv6Address Property
IPv6NegotiationErrorCode Property
Options Property
PrefixLength Property
ServerIPv4Address Property
ServerIPv4Addresses Property
ServerIPv6Address Property
ServerIPv6Addresses Property
RasIkeV2Options Class
RasIkeV2Options Members
RasIkeV2Options Methods
RasIkeV2Options Properties
ClientBehindNat Property
MobileIke Property
ServerBehindNat Property
RasIPInfo Class
RasIPInfo Members
RasIPInfo Methods
RasIPInfo Properties
ErrorCode Property
IPAddress Property
Options Property
ServerIPAddress Property
ServerOptions Property
RasIPOptions Class
RasIPOptions Members
RasIPOptions Methods
Clone Method
RasIPOptions Properties
VJ Property
RasIPSecEncryptionType Enumeration
RasIPv6Info Class
RasIPv6Info Members
RasIPv6Info Methods
RasIPv6Info Properties
ErrorCode Property
LocalCompressionProtocol Property
LocalInterfaceIdentifier Property
PeerCompressionProtocol Property
PeerInterfaceIdentifier Property
RasIpxInfo Class
RasIpxInfo Members
RasIpxInfo Methods
RasIpxInfo Properties
ErrorCode Property
IpxAddress Property
RasIsolationState Enumeration
RasLcpAuthenticationDataType Enumeration
RasLcpAuthenticationType Enumeration
RasLcpInfo Class
RasLcpInfo Members
RasLcpInfo Methods
RasLcpInfo Properties
AuthenticationData Property
AuthenticationProtocol Property
Bundled Property
EapTypeId Property
ErrorCode Property
Multilink Property
Options Property
ReplyMessage Property
ServerAuthenticationData Property
ServerAuthenticationProtocol Property
ServerEapTypeId Property
ServerOptions Property
ServerTerminateReason Property
TerminateReason Property
RasLcpOptions Class
RasLcpOptions Members
RasLcpOptions Methods
Clone Method
RasLcpOptions Properties
Acfc Property
Aes128 Property
Aes256 Property
Des56 Property
Pfc Property
Sshf Property
TripleDes Property
RasLinkStatistics Class
RasLinkStatistics Members
RasLinkStatistics Methods
RasLinkStatistics Properties
AlignmentError Property
BufferOverrunError Property
BytesReceived Property
BytesTransmitted Property
CompressionRatioIn Property
CompressionRatioOut Property
ConnectionDuration Property
CrcError Property
FramesReceived Property
FramesTransmitted Property
FramingError Property
HardwareOverrunError Property
LinkSpeed Property
TimeoutError Property
RasNapStatus Class
RasNapStatus Members
RasNapStatus Methods
RasNapStatus Properties
IsolationState Property
ProbationTime Property
RasNbfInfo Class
RasNbfInfo Members
RasNbfInfo Methods
RasNbfInfo Properties
ErrorCode Property
Lana Property
NetBiosErrorCode Property
NetBiosErrorMessage Property
WorkstationName Property
RasNetworkProtocols Class
RasNetworkProtocols Members
RasNetworkProtocols Constructor
RasNetworkProtocols Methods
Clone Method
RasNetworkProtocols Properties
IP Property
IPv6 Property
Ipx Property
NetBeui Property
RasPhoneBook Class
RasPhoneBook Members
RasPhoneBook Constructor
RasPhoneBook Constructor
RasPhoneBook Constructor (IContainer)
RasPhoneBook Methods
GetPhoneBookPath Method
Open Method
Open Method
Open Method (Boolean)
Open Method (String)
RasPhoneBook Properties
EnableFileWatcher Property
Entries Property
Path Property
PhoneBookType Property
RasPhoneBook Events
Changed Event
Deleted Event
Renamed Event
RasPhoneBookDialog Class
RasPhoneBookDialog Members
RasPhoneBookDialog Constructor
RasPhoneBookDialog Methods
Reset Method
RasPhoneBookDialog Properties
CallbackId Property
EntryName Property
PhoneBookPath Property
RasPhoneBookDialog Events
AddedEntry Event
ChangedEntry Event
DialedEntry Event
RemovedEntry Event
RasPhoneBookDialogEventArgs Class
RasPhoneBookDialogEventArgs Members
RasPhoneBookDialogEventArgs Constructor
RasPhoneBookDialogEventArgs Methods
RasPhoneBookDialogEventArgs Properties
CallbackId Property
Data Property
Text Property
RasPhoneBookType Enumeration
RasPppInfo Class
RasPppInfo Members
RasPppInfo Methods
RasPppInfo Properties
AuthenticationData Property
AuthenticationProtocol Property
CcpCompressionAlgorithm Property
CcpOptions Property
EapTypeId Property
InterfaceIdentifier Property
IPAddress Property
IPv4NegotiationErrorCode Property
IPv6NegotiationErrorCode Property
IsBundled Property
IsMultilink Property
LcpOptions Property
Options Property
ServerAuthenticationData Property
ServerAuthenticationProtocol Property
ServerCcpCompressionAlgorithm Property
ServerCcpOptions Property
ServerEapTypeId Property
ServerInterfaceIdentifier Property
ServerIPAddress Property
ServerLcpOptions Property
ServerOptions Property
RasPreSharedKey Enumeration
RasProjectionType Enumeration
RasSlipInfo Class
RasSlipInfo Members
RasSlipInfo Methods
RasSlipInfo Properties
ErrorCode Property
IPAddress Property
RasSubEntry Class
RasSubEntry Members
RasSubEntry Constructor
RasSubEntry Methods
Clone Method
Remove Method
Update Method
RasSubEntry Properties
AlternatePhoneNumbers Property
Device Property
Owner Property
PhoneNumber Property
RasSubEntryCollection Class
RasSubEntryCollection Members
RasSubEntryCollection Methods
RasSubEntryCollection Properties
RasUpdateCredential Enumeration
RasVpnStrategy Enumeration
StateChangedEventArgs Class
StateChangedEventArgs Members
StateChangedEventArgs Methods
StateChangedEventArgs Properties
CallbackId Property
ErrorCode Property
ErrorMessage Property
ExtendedErrorCode Property
Handle Property
State Property
SubEntryId Property
DotRas.Design Namespace
RasCollection(TObject) Class
RasCollection(TObject) Members
RasCollection(TObject) Constructor
RasCollection(TObject) Methods
Add Method
Clear Method
ClearItems Method
Contains Method
CopyTo Method
GetEnumerator Method
IndexOf Method
InsertItem Method
Remove Method
RemoveAt Method
RemoveItem Method
RasCollection(TObject) Properties
Count Property
IsInitializing Property
IsReadOnly Property
Item Property
RasCommonDialog Class
RasCommonDialog Members
RasCommonDialog Constructor
RasCommonDialog Methods
OnError Method
Reset Method
RasCommonDialog Properties
Location Property
RasCommonDialog Events
Error Event
RasComponent Class
RasComponent Members
RasComponent Constructor
RasComponent Constructor
RasComponent Constructor (IContainer)
RasComponent Methods
InitializeComponent Method
OnError Method
RaiseEvent(TEventArgs) Method
RasComponent Properties
SynchronizingObject Property
RasComponent Events
Error Event
RasOwnedCollection(TOwner, TObject) Class
RasOwnedCollection(TOwner, TObject) Members
RasOwnedCollection(TOwner, TObject) Constructor
RasOwnedCollection(TOwner, TObject) Methods
RasOwnedCollection(TOwner, TObject) Properties
Owner Property

DotRas SDK Documentation

DotRas SDK

Table of contents

Get in touch