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.

Class Name

IPWorks_NetDial

Procedural Interface

 ipworks_netdial_open();
 ipworks_netdial_close($res);
 ipworks_netdial_register_callback($res, $id, $function);
 ipworks_netdial_get_last_error($res);
 ipworks_netdial_get_last_error_code($res);
 ipworks_netdial_set($res, $id, $index, $value);
 ipworks_netdial_get($res, $id, $index);
 ipworks_netdial_do_config($res, $configurationstring);
 ipworks_netdial_do_connect($res);
 ipworks_netdial_do_createentry($res);
 ipworks_netdial_do_deleteentry($res);
 ipworks_netdial_do_disconnect($res);
 ipworks_netdial_do_doevents($res);
 ipworks_netdial_do_interrupt($res);
 ipworks_netdial_do_listconnections($res);
 ipworks_netdial_do_listdevices($res);
 ipworks_netdial_do_listphonebook($res);
 ipworks_netdial_do_reset($res);
 ipworks_netdial_do_showdialdialog($res);

Remarks

The user can either directly provide a PhoneNumber, User, Password, and optionally a Domain and CallbackNumber, or get those entries from PhonebookEntry of Phonebook. The calls are blocking but progress information is given through the 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. ConnectedEntry and PhonebookEntry 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.

CallbackNumberThe callback number to give when directly dialing the remote machine.
DomainThe name of the domain to join when dialing the RAS connection.
EntryDeviceNameThe device of the phonebook entry pointed to by PhonebookEntry .
EntryDeviceTypeThe device type of the phonebook entry pointed to by PhonebookEntry .
EntryDNSServerThe DNS server of the phonebook entry pointed to by PhonebookEntry .
EntryIPAddressThe IP address of the phonebook entry pointed to by PhonebookEntry .
EntryPhoneNumberThe phone number for the phonebook entry pointed to by PhonebookEntry .
EntryWINSServerThe 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.
PhonebookEntryThe name of PhonebookEntry to use when dialing the remote machine.
PhoneNumberThe number to dial when directly dialing the remote machine without the help of a PhonebookEntry .
RASAvailableWhen 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 .
CreateEntryCreates a PhonebookEntry .
DeleteEntryDeletes a PhonebookEntry .
DisconnectDisconnects the last successfully made connection.
DoEventsProcesses events from the internal message queue.
InterruptInterrupt the current method.
ListConnectionsLists all current connections.
ListDevicesLists all dial devices.
ListPhonebookLists all entries in Phonebook .
ResetReset the class.
ShowDialDialogShows 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.

ConnectedEntryFired for every connected device when the ListConnections method is called.
DeviceFired for every dial device when the ListDevices method is called.
ErrorInformation about errors during data delivery.
PhonebookEntryFired for every Phonebook entry when the ListPhonebook method is called.
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 PHP Edition - Version 20.0 [Build 8307]