Host Access Class Library LotusScript Extension

Note:
Not applicable for 64-bit PCOMM
The Host Access Class Library LotusScript Extension (ECLLSX) allows you to write LotusScript programs that can query and control Personal Communications connections. The ECLLSX contains several new LotusScript classes that can be used inside LotusScript programs. By running methods on objects created from the new classes, you can access Personal Communications connection information and control the objects that make up a Personal Communications connection.
For example, if you want to automate the task of entering a line of text in a Personal Communications connection you can write a LotusScript program that uses the lsxECLPS class to create an lsxECLPS object associated with the presentation space of a Personal Communications connection. You can then run the SendKeys method on this lsxECLPS object to send a series of keystrokes to the presentation space and the effect is similar to a user typing the keystrokes in that presentation space. The following code fragment shows how this would be done using the ECLLSX classes.
'Create an lsxECLPS object associated with Personal
'Communications connection A
dim myPSObj as new lsxECLPS("A")
 
'Send some keystrokes to the presentation space of
'connection A
myPSObj.Sendkeys("[clear]QUERY FILES[ENTER]")

The ECLLSX classes are similar to the ECL C++ classes. Each ECLLSX class begins with lsxECL, for LotusScript Host Access Class Library. The classes are as follows:

  • lsxECLConnection, Connection Information, on page lsxECLConnection Class provides information about the Personal Communications connection associated with this lsxECLConnection object. In addition to being included in an lsxECLConnList object, an lsxECLConnection object can be created on its own if you only want to query information on a specific Personal Communications connection.
  • lsxECLConnList, Connection List, on page lsxECLConnList Class provides a list of Personal Communications connections on a system. Each element in an lsxECLConnList is an lsxECLConnection object.
  • lsxECLConnMgr, Connection Manager, on page lsxECLConnMgr Class manages Personal Communications connections on a system. Each lsxECLConnMgr object contains an lsxECLConnList object.
  • lsxECLField, Field Information, on page lsxECLField Class provides information on a field in the presentation space of the Personal Communications connection associated with this lsxECLField object.
  • lsxECLFieldList, Field List, on page lsxECLFieldList Class provides a list of the fields in the presentation space of the Personal Communications connection associated with this lsxECLFieldList object. Each element in the list is an lsxECLField object.
  • lsxECLOIA, Operator Information Area, on page lsxECLOIA Class provides methods to query and manipulate the Operator Information Area of the associated Personal Communications connection. In addition to being contained in an lsxECLSession object, an lsxECLOIA object can be created on its own if you only want to perform OIA related tasks.
  • lsxECLPS, Presentation Space, on page lsxECLPS Class provides methods to query and manipulate the Presentation Space of the associated Personal Communications connection. An lsxECLPS object contains an lsxECLFieldList object. In addition to being contained in an lsxECLSession object, an lsxECLPS object can be created on its own if you only want to perform presentation space related tasks.
  • lsxECLScreenDesc, Screen Description, on page lsxECLScreenDesc Class provides methods and properties to describe a screen. This may be used to wait for screens on the autECLPS object or the autECLScreenReco object.
  • lsxECLScreenReco, Screen Recognition, on page lsxECLScreenReco Class provides the engine of the HACL screen recognition system.
  • lsxECLSession, Session, on page lsxECLSession Class provides Personal Communications connection related functionality and information. For convenience, an lsxECLSession object contains lsxECLPS, lsxECLXfer, lsxECLWinMetrics and lsxECLOIA objects for the Personal Communications connection associated with the lsxECLSession object.
  • lsxECLWinMetrics, Window Metrics, on page lsxECLWinMetrics Class provides methods to query the window metrics of the Personal Communications connection associated with this lsxECLWinMetrics object. In addition to being contained in an lsxECLSession object, an lsxECLWinMetrics object can be created on its own if you only want to perform window metrics related queries.
  • lsxECLXfer, File Transfer, on page lsxECLXfer Class provides methods to transfer files between the host and the workstation over the Personal Communications connection associated with this file transfer object. In addition to being contained in an lsxECLSession object, an lsxECLXfer object can be created on its own if you only want to perform file transfer related tasks
In order to use the ECL LotusScript Extension classes in a LotusScript program, you must load the ECL LotusScript Extension. This can be done using the following LotusScript statement:
USELSX "*pcslsx"

This statement loads the ECL LotusScript Extension and allows you to access the ECL LotusScript Extension classes.

This chapter describes each class’ methods and properties in detail.