TrayIcon/DialUp/README.TXT
2021-09-12 22:21:22 +02:00

141 lines
5.0 KiB
Plaintext

(****************************************** |******************************************
* RAR, dekompresni komponenta * |* RAR, decompression component *
* pro Delphi 3 (32b) * |* for Delphi 3 (32b) *
* (c) 1997 BEALsoft * |* (c) 1997 BEALsoft *
* v1.0 * |* v1.0 *
*________________________________________* |*________________________________________*
* !! TATO KOMPONENTA JE ZDARMA !! * |* !! THIS COMPONENT IS FREE !! *
****************************************** |******************************************)
// Kontakt na autora // Contact to author :
// aberka@usa.net, ICQ UIN 2365308, http://jakub.naf.cz/~aberka
// BEALsoft BBS, +420-5-<MOMENTALNE NENI / NONE AT THE MOMENT>, 24h
// ** Nove telefonni cislo bude umisteno na me webovske stranky **
// ** New phone number will be placen on my web pages **
// Thanx to Davide Moretti for his RAS API header (Some code in this component
// was written by him). You can reach him via e-mail: dmoretti@iper.net
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
Nasledujici dokumentace je JEN v anglictine, protoze predpokladam u programatoru
znalost anglictiny.
It is recommended to read the source code, its comments.
RAS API functions are described in WIN32.HLP (Shipped with 32b Delphi)
METHODS:
=======
function Dial : Integer;
Dials <ENTRY> connection.
Non-zero result means error; OnError event also occurs.
function GetEntries : Integer;
Get available connections
Connections are stored in <ENTRIES>. OnEntryGet event occurs
function GetConnections : Integer;
Get active connection
Connections are passed thru OnActiveConnection
function HangUp : Integer;
Hangups the connection you dialed with this component
function HangUpConn(Handle : THRasConn) : Integer;
Hangups the connection identified by Handle (OnActiveConnection)
function CreateEntry : Integer;
Creates entry in phonebook and displays edit dialog
function EditEntry : Integer;
Opens edit dialog for <ENTRY>
function DeleteEntry : Integer;
Delete <ENTRY> from phonebook
function RenameEntryTo(S : String) : Integer;
Rename <ENTRY> to <S>
function SetEntryUserName(Value : String) : Integer;
Set new username (<VALUE>) to <ENTRY>
function SetEntryPassword(Value : String) : Integer;
Set new password (<VALUE>) to <ENTRY>
function RemovePassword : Integer;
Remove password from <ENTRY>
function GetEntryUserName(var Value : String) : Integer;
Get username from <ENTRY> to <VALUE>
function GetEntryPassword(var Value : String) : Integer;
Get password from <ENTRY> to <VALUE>
function StatusString(State: TRasConnState; Error: Integer): String;
Get string describing <STATE> and <ERROR>
function StatusStringCZ(State: TRasConnState; Error: Integer): String;
Get Czech string describing <STATE> and <ERROR>
PROPERTIES:
===========
property DialMode (TDialMode ... dmAsync/dmSync)
-----------------
Property describing the mode of dialing.
Async dialing means that user will be notified when anything happen
by event. See OnAsyncEvent. [onDialing,onError,onAsyncEvent]
Sync dialing means that Dial function will exit when dialing finished.
Dial function result gives neccessary information. [onDialing,onConnect,onNotConnected]
property Entry (String)
--------------
Identifies which entry will be processed by Dial,EditEntry,DeleteEntry,
GetEntryUserName,...
property Language (TLanguage ... Czech/English)
-----------------
Choose your language. Used for events with string messages.
EVENTS:
=======
OnEntryGet, procedure (Sender : TObject; EntryName : Array of Char) of Object;
----------
This event occurs when an Entry was found in phonebook by GetEntris method.
OnDialing, procedure (Sender : TObject) of object;
---------
This event occurs when Dial method is executed.
OnConnect, procedure (Sender : TObject) of object;
---------
This event occrus when connected with Dial method.
^^^^^^^^^^^
OnNotConnected, procedure (Sender : TObject; ErrorCode : Integer; ErrorMessage : String) of object;
--------------
This event is called when dialing failed.
OnAsyncEvent, procedure (Sender : TObject; State : TRasConnState; Error : Integer;
------------ MessageText : String) of object;
This event is called by RAS when dialing in Async mode. Gives information
about current process.
OnError, procedure (Sender : TObject; ErrorCode : Integer; ErrorMessage : String) of Object;
-------
This event is called when error occur in Dial method etc.
OnActiveConnection, procedure (Sender : TObject; Handle : THRasConn; Status : TRasConnStatus;
------------------ StatusString : String;
EntryName, DeviceType, DeviceName : Array of Char) of object;
This event is called when an active connection was found by GetConnections.
Gives neccessary information about found connection.