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_numberThe callback number to give when directly dialing the remote machine.
domainThe name of the domain to join when dialing the RAS connection.
entry_device_nameThe device of the phonebook entry pointed to by PhonebookEntry .
entry_device_typeThe device type of the phonebook entry pointed to by PhonebookEntry .
entry_dns_serverThe DNS server of the phonebook entry pointed to by PhonebookEntry .
entry_ip_addressThe IP address of the phonebook entry pointed to by PhonebookEntry .
entry_phone_numberThe phone number for the phonebook entry pointed to by PhonebookEntry .
entry_wins_serverThe WINS server of the phonebook entry pointed to by PhonebookEntry .
handleThe handle of the connection. 0 if invalid or not connected.
idleThe current status of the class.
passwordThe password to use when direct dialing the remote machine.
phonebookThis property reads the PhonebookEntry when dialing the remote machine.
phonebook_entryThe name of PhonebookEntry to use when dialing the remote machine.
phone_numberThe number to dial when directly dialing the remote machine without the help of a PhonebookEntry .
ras_availableWhen true, Remote Access System (RAS) is available on the system.
timeoutA timeout for the class.
userThe 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.

configSets or retrieves a configuration setting.
connectAttempts to dial the PhonebookEntry from Phonebook .
create_entryCreates a PhonebookEntry .
delete_entryDeletes a PhonebookEntry .
disconnectDisconnects the last successfully made connection.
do_eventsProcesses events from the internal message queue.
interruptInterrupt the current method.
list_connectionsLists all current connections.
list_devicesLists all dial devices.
list_phonebookLists all entries in Phonebook .
resetReset the class.
show_dial_dialogShows 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_entryFired for every connected device when the ListConnections method is called.
on_deviceFired for every dial device when the ListDevices method is called.
on_errorInformation about errors during data delivery.
on_phonebook_entryFired for every Phonebook entry when the ListPhonebook method is called.
on_statusFired 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.

IgnoreModemSpeakerWhether the class will ignore the default modem speaker settings.
IgnoreSoftwareCompressionWhether the class will ignore the default software compression settings.
OverrideEntrySettingWhether or not to use the class settings when dialing a phone book entry.
PausedStatesWhether the class will accept paused states.
PauseOnScriptTells the class to display a logon terminal.
SetModemSpeakerWhether the class will use the modem speaker.
SetSoftwareCompressionWhether the class will use software compression.
UseCustomScriptingTells the class to use custom script DLLs.
UsePrefixSuffixWhether or not to use the dialing prefix and suffix in the phone book.
UseRemoteDefaultGatewayWhether or not the entry should use the default gateway on the remote network.
VPNTypeSets the VPN Type when creating entries with NetDial.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 Python Edition - Version 20.0 [Build 8307]