NSBasic Win32 objects

RASEntry object

Applies to: RAS object

Members reference

Name Syntax Description
Name object.Name = value
variable = object.Name
Specifies the RAS phonebook entry's Name
CallbackNumber object.CallbackNumber = value
variable = object.CallbackNumber
Specifies the callback phone number (or IP/DNS name for VPN connections) for the entry as string.
UserName object.UserName = value
variable = object.UserName
Specifies the user name for the RAS entry
Domain object.Domain = value
variable = object.Domain
Specifies the domain name for the RAS entry. Most often it is empty to indicate the default domain of the RAS server to which the entry connects.
Password object.Domain = value Sets the password for the entry. You should call Update if you want to save it within the phonebook. Be aware that different OS versions may have different default policies about this - save the password for the current user, for all users, do not permit saving etc.
PhoneNumber object.PhoneNumber = value
variable = object.PhoneNumber
Override phone number (or IP/DNS name for VPN connections) for the entry. The entries most often have one or more phone numbers saved in the RAS phonebook. This property allows you to override the number(s) from it with a specific phone number before dialing up. Otherwise this property has no persistent effect over the entries (i.e. it is not saved)
Connect object.Connect() Attempts to dial up and connect the entry.
Disconnect object.Disconnect() Attempts to hang up. Note that you must have a connected RASEntry object in order this to succeed. For example such object can be obtained from the RAS.Connections collection. Otherwise you should have called Connect over the same entry before. See also ResetState.
Load object.Load() Reloads the entry from the RAS phonebook.
Update object.Update() Updates the entry data in the RAS phonebook.
Delete object.Delete() Deletes the entry from the RAS phonebook.
HasPassword object.HasPassword = value
variable = object.HasPassword 
Boolean indicating if the entry has saved password. If you set it to false the saved password will be deleted when you call Update.
IsActive variable = object.IsActive  Indicates if the entry is in active - connected or connecting state. Note that this is not completely reliable for long periods of time because it indicates the last known state. If you want to make sure you are dealing with the current state of the entry call ResetState or query the entry state through the Status property. 
Status o = object.Status Returns RASConState object which enables you to query details about the entry's current state. The RASConState object and the entry object are updated with the current state (i.e. the object automatically attempts to determine what is happening with this entry when you read this property - is it connected or not, what is the status of the connection etc.).  
ResetState object.ResetState() Attempts to determine the current state of the entry - updates the connected/connecting state etc. After calling this method IsActive is ensured to indicate the current state of the entry.

 

 

 

Copyright 2005 NSBasic Corporation