NetDial Class
Properties Methods Events Configuration Settings Errors
The NetDial class can be used to call the Remote Access System (RAS) to initiate or break connections to remote hosts, list connections, and phonebook entries.
Syntax
class ipworks.NetDial
Remarks
The user can either directly provide a phone_number, user, password, and optionally a domain and callback_number, or get those entries from phonebook_entry of phonebook. The calls are blocking but progress information is given through the on_status event and Windows messages will come during connect or disconnect methods.
The user can get information on the phonebook entries and connections by calling the respective methods of the class. on_connected_entry and on_phonebook_entry events will fire with the required information.
Support is also provided for creating and/or deleting phonebook entries, as well as listing the various RAS devices supported by the system.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
callback_number | The callback number to give when directly dialing the remote machine. |
domain | The name of the domain to join when dialing the RAS connection. |
entry_device_name | The device of the phonebook entry pointed to by PhonebookEntry . |
entry_device_type | The device type of the phonebook entry pointed to by PhonebookEntry . |
entry_dns_server | The DNS server of the phonebook entry pointed to by PhonebookEntry . |
entry_ip_address | The IP address of the phonebook entry pointed to by PhonebookEntry . |
entry_phone_number | The phone number for the phonebook entry pointed to by PhonebookEntry . |
entry_wins_server | The WINS server of the phonebook entry pointed to by PhonebookEntry . |
handle | The handle of the connection. 0 if invalid or not connected. |
idle | The current status of the class. |
password | The password to use when direct dialing the remote machine. |
phonebook | This property reads the PhonebookEntry when dialing the remote machine. |
phonebook_entry | The name of PhonebookEntry to use when dialing the remote machine. |
phone_number | The number to dial when directly dialing the remote machine without the help of a PhonebookEntry . |
ras_available | When true, Remote Access System (RAS) is available on the system. |
timeout | A timeout for the class. |
user | The name of the login user when directly dialing the remote machine. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
config | Sets or retrieves a configuration setting. |
connect | Attempts to dial the PhonebookEntry from Phonebook . |
create_entry | Creates a PhonebookEntry . |
delete_entry | Deletes a PhonebookEntry . |
disconnect | Disconnects the last successfully made connection. |
do_events | Processes events from the internal message queue. |
interrupt | Interrupt the current method. |
list_connections | Lists all current connections. |
list_devices | Lists all dial devices. |
list_phonebook | Lists all entries in Phonebook . |
reset | Reset the class. |
show_dial_dialog | Shows the standard RAS dialog for dialing the PhonebookEntry from Phonebook . |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
on_connected_entry | Fired for every connected device when the ListConnections method is called. |
on_device | Fired for every dial device when the ListDevices method is called. |
on_error | Information about errors during data delivery. |
on_phonebook_entry | Fired for every Phonebook entry when the ListPhonebook method is called. |
on_status | Fired during connection or disconnection attempts. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
IgnoreModemSpeaker | Whether the class will ignore the default modem speaker settings. |
IgnoreSoftwareCompression | Whether the class will ignore the default software compression settings. |
OverrideEntrySetting | Whether or not to use the class settings when dialing a phone book entry. |
PausedStates | Whether the class will accept paused states. |
PauseOnScript | Tells the class to display a logon terminal. |
SetModemSpeaker | Whether the class will use the modem speaker. |
SetSoftwareCompression | Whether the class will use software compression. |
UseCustomScripting | Tells the class to use custom script DLLs. |
UsePrefixSuffix | Whether or not to use the dialing prefix and suffix in the phone book. |
UseRemoteDefaultGateway | Whether or not the entry should use the default gateway on the remote network. |
VPNType | Sets the VPN Type when creating entries with NetDial. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |