Contents

Figures
Tables
About This Book
Who Should Read This Book
How to Use This Book
Where to Find More Information
Support Options
Subscribing to Support News
Support Assistant
Introduction
C++ Objects
HACL C++ 1390/1399 Code Page Support
Java Objects
Automation Objects
LotusScript Extension
ECL Concepts
Connections, Handles and Names
Sessions
ECL Container Objects
ECL List Objects
Events
Error Handling
Addressing (Rows, Columns, Positions)
Migrating from EHLLAPI
Execution/Language Interface
Features
Session IDs
Presentation Space Models
SendKey Interface
Events
PS Connect/Disconnect and Multithreading
Host Access Class Library C++
Building C++ ECL Programs
IBM Visual Age C++
Microsoft Visual C++
ECLBase Class
Derivation
ECLBase Methods
GetVersion
ConvertHandle2ShortName
ConvertShortName2Handle
ConvertTypeToString
ConvertPos
ECLConnection Class
Derivation
ECLConnection Methods
ECLConnection Constructor
ECLConnection Destructor
GetCodePage
GetHandle
GetConnType
GetName
GetEncryptionLevel
IsStarted
IsCommStarted
IsAPIEnabled
IsReady
IsDBCSHost
StartCommunication
StopCommunication
RegisterCommEvent
UnregisterCommEvent
ECLConnList Class
Derivation
Usage Notes
ECLConnList Methods
ECLConnList Constructor
ECLConnList Destructor
GetFirstConnection
GetNextConnection
FindConnection
GetCount
Refresh
ECLConnMgr Class
Derivation
ECLConnMgr Methods
ECLConnMgr Constructor
ECLConnMgr Deconstructor
GetConnList
StartConnection
StopConnection
RegisterStartEvent
UnregisterStartEvent
ECLCommNotify Class
Derivation
Example
ECLCommNotify Methods
NotifyEvent
NotifyError
NotifyStop
ECLErr Class
Derivation
ECLErr Methods
GetMsgNumber
GetReasonCode
GetMsgText
ECLField Class
Derivation
ECLField Methods
GetStart
GetStartRow
GetStartCol
GetEnd
GetEndRow
GetEndCol
GetLength
GetScreen
SetText
IsModified, IsProtected, IsNumeric, IsHighIntensity, IsPenDetectable, IsDisplay
GetAttribute
ECLFieldList Class
Derivation
Properties
ECLFieldList Methods
Refresh
GetFieldCount
GetFirstField
GetNextField
FindField
ECLKeyNotify Class
Derivation
Example
ECLKeyNotify Methods
NotifyEvent
NotifyError
NotifyStop
ECLListener Class
Derivation
Usage Notes
ECLOIA Class
Derivation
Usage Notes
ECLOIA Methods
ECLOIA Constructor
IsAlphanumeric
IsAPL
IsKatakana
IsHiragana
IsDBCS
IsUpperShift
IsNumeric
IsCapsLock
IsInsertMode
IsCommErrorReminder
IsMessageWaiting
WaitForInputReady
WaitForSystemAvailable
WaitForAppAvailable
WaitForTransition
InputInhibited
GetStatusFlags
RegisterOIAEvent
UnregisterOIAEvent
ECLOIANotify Class
Derivation
Usage Notes
ECLOIANotify Methods
NotifyEvent
NotifyError
NotifyStop
ECLPS Class
Derivation
Properties
Usage Notes
ECLPS Methods
ECLPS Constructor
ECLPS Destructor
GetPCCodePage
GetHostCodePage
GetOSCodePage
GetSize
GetSizeRows
GetSizeCols
GetCursorPos
GetCursorPosRow
GetCursorPosCol
SetCursorPos
SendKeys
SearchText
GetScreen
GetScreenRect
SetText
ConvertPosToRowCol
ConvertRowColToPos
ConvertPosToRow
ConvertPosToCol
RegisterKeyEvent
UnregisterKeyEvent
GetFieldList
WaitForCursor
WaitWhileCursor
WaitForString
WaitWhileString
WaitForStringInRect
WaitWhileStringInRect
WaitForAttrib
WaitWhileAttrib
WaitForScreen
WaitWhileScreen
RegisterPSEvent
StartMacro
UnregisterPSEvent
ECLPSEvent Class
Derivation
Usage Notes
ECLPSEvent Methods
GetPS
GetType
GetStart
GetEnd
GetStartRow
GetStartCol
GetEndRow
GetEndCol
ECLPSListener Class
Derivation
Usage Notes
ECLPSListener Methods
NotifyEvent
NotifyError
NotifyStop
ECLPSNotify Class
Derivation
Usage Notes
ECLPSNotify Methods
NotifyEvent
NotifyError
NotifyStop
ECLRecoNotify Class
Derivation
ECLRecoNotify Methods
ECLRecoNotify Constructor
ECLRecoNotify Destructor
NotifyEvent
NotifyStop
NotifyError
ECLScreenDesc Class
Derivation
ECLScreenDesc Methods
ECLScreenDesc Constructor
ECLScreenDesc Destructor
AddAttrib
AddCursorPos
AddNumFields
AddNumInputFields
AddOIAInhibitStatus
AddString
AddStringInRect
Clear
ECLScreenReco Class
Derivation
ECLScreenReco Methods
ECLScreenReco Constructor
ECLScreenReco Destructor
AddPS
IsMatch
RegisterScreen
RemovePS
UnregisterScreen
ECLSession Class
Derivation
Properties
Usage Notes
ECLSession Methods
ECLSession Constructor
ECLSession Destructor
GetPS
GetOIA
GetXfer
GetWinMetrics
GetPageSettings
GetPrinterSettings
RegisterUpdateEvent
UnregisterUpdateEvent
ECLStartNotify Class
Derivation
Example
ECLStartNotify Methods
NotifyEvent
NotifyError
NotifyStop
ECLUpdateNotify Class
ECLWinMetrics Class
Derivation
Properties
Usage Notes
ECLWinMetrics Methods
ECLWinMetrics Constructor
ECLWinMetrics Destructor
GetWindowTitle
SetWindowTitle
GetXpos
SetXpos
GetYpos
SetYpos
GetWidth
SetWidth
GetHeight
SetHeight
GetWindowRect
SetWindowRect
IsVisible
SetVisible
IsActive
SetActive
IsMinimized
SetMinimized
IsMaximized
SetMaximized
IsRestored
SetRestored
ECLXfer Class
Derivation
Properties
Usage Notes
ECLXfer Methods
ECLXfer Constructor
ECLXfer Destructor
SendFile
ReceiveFile
ECLPageSettings Class
Derivation
Properties
Restrictions
Usage Notes
ECLPageSettings Methods
Connection types
ECLPageSettings Constructor
SetCPI
GetCPI
IsFontCPI
SetLPI
GetLPI
IsFontLPI
SetFontFaceName
GetFontFaceName
SetFontSize
GetFontSize
SetMaxLinesPerPage
GetMaxLinesPerPage
SetMaxCharsPerLine
GetMaxCharsPerLine
RestoreDefaults
ECLPrinterSettings Class
Derivation
Properties
Restrictions
Usage Notes
ECLPrinterSettings Methods
ECLPrinterSettings Constructor
SetPDTMode
GetPDTFile
IsPDTMode
GetPrintMode
SetPrtToDskAppend
GetPrtToDskAppendFile
SetPrtToDskSeparate
GetPrtToDskSeparateFile
SetSpecificPrinter
SetWinDefaultPrinter
GetPrinterName
SetPromptDialog
IsPromptDialogEnabled
Host Access Class Library Automation Objects
autSystem Class
autECLConnList Class
Properties
autECLConnList Methods
Collection Element Methods
Refresh
FindConnectionByHandle
FindConnectionByName
StartCommunication
StopCommunication
autECLConnMgr Class
Properties
autECLConnMgr Methods
RegisterStartEvent
UnregisterStartEvent
StartConnection
StopConnection
autECLConnMgr Events
NotifyStartEvent
NotifyStartError
NotifyStartStop
Event Processing Example
autECLFieldList Class
Properties
autECLFieldList Methods
Collection Element Methods
Refresh
FindFieldByRowCol
FindFieldByText
GetText
SetText
autECLOIA Class
Properties
autECLOIA Methods
RegisterOIAEvent
UnregisterOIAEvent
SetConnectionByName
SetConnectionByHandle
StartCommunication
StopCommunication
WaitForInputReady
WaitForSystemAvailable
WaitForAppAvailable
WaitForTransition
CancelWaits
autECLOIA Events
NotifyOIAEvent
NotifyOIAError
NotifyOIAStop
Event Processing Example
autECLPS Class
Properties
autECLPS Methods
RegisterPSEvent
RegisterKeyEvent
RegisterCommEvent
UnregisterPSEvent
UnregisterKeyEvent
UnregisterCommEvent
SetConnectionByName
SetConnectionByHandle
SetCursorPos
SendKeys
SearchText
GetText
SetText
GetTextRect
SetTextRect
StartCommunication
StopCommunication
StartMacro
Wait
WaitForCursor
WaitWhileCursor
WaitForString
WaitWhileString
WaitForStringInRect
WaitWhileStringInRect
WaitForAttrib
WaitWhileAttrib
WaitForScreen
WaitWhileScreen
CancelWaits
autECLPS Events
NotifyPSEvent
NotifyKeyEvent
NotifyCommEvent
NotifyPSError
NotifyKeyError
NotifyCommError
NotifyPSStop
NotifyKeyStop
NotifyCommStop
Event Processing Example
autECLScreenDesc Class
autECLScreenDesc Methods
AddAttrib
AddCursorPos
AddNumFields
AddNumInputFields
AddOIAInhibitStatus
AddString
AddStringInRect
Clear
autECLScreenReco Class
autECLScreenReco Methods
AddPS
IsMatch
RegisterScreen
RemovePS
UnregisterScreen
autECLScreenReco Events
NotifyRecoEvent
NotifyRecoError
NotifyRecoStop
Event Processing Example
autECLSession Class
Properties
autECLSession Methods
RegisterSessionEvent
RegisterCommEvent
UnregisterSessionEvent
UnregisterCommEvent
SetConnectionByName
SetConnectionByHandle
StartCommunication
StopCommunication
autECLSession Events
NotifyCommEvent
NotifyCommError
NotifyCommStop
Event Processing Example
autECLWinMetrics Class
Properties
autECLWinMetrics Methods
RegisterCommEvent
UnregisterCommEvent
SetConnectionByName
SetConnectionByHandle
GetWindowRect
SetWindowRect
StartCommunication
StopCommunication
autECL WinMetrics Events
NotifyCommEvent
NotifyCommError
NotifyCommStop
Event Processing Example
autECLXfer Class
Properties
autECLXfer Methods
RegisterCommEvent
UnregisterCommEvent
SetConnectionByName
SetConnectionByHandle
SendFile
ReceiveFile
StartCommunication
StopCommunication
autECLXfer Events
NotifyCommEvent
NotifyCommError
NotifyCommStop
Event Processing Example
autSystem Class
autSystem Methods
Shell
Inputnd
autECLPageSettings Class
Usage Notes
Restrictions
Connection types
Properties
autECLPageSettings Methods
RestoreTextDefaults
SetConnectionByName
SetConnectionByHandle
autECLPrinterSettings Class
Usage Notes
Restrictions
Properties
autECLPrinterSettings Methods
SetPDTMode
SetPrtToDskAppend
SetPrtToDskSeparate
SetSpecificPrinter
SetWinDefaultPrinter
SetConnectionByName
SetConnectionByHandle
Support For Primary Interop Assemblies for Automation Objects
Host Access Class Library LotusScript Extension
lsxECLConnection Class
Properties
lsxECLConnection Methods
StartCommunication
StopCommunication
lsxECLConnList Class
Properties
lsxECLConnList Methods
Refresh
FindConnectionByHandle
FindConnectionByName
lsxECLConnMgr Class
Properties
lsxECLConnMgr Methods
StartConnection
StopConnection
lsxECLField Class
Properties
lsxECLField Methods
GetText
SetText
lsxECLFieldList Class
Properties
lsxECLFieldList Methods
Refresh
FindFieldByRowCol
FindFieldByText
lsxECLOIA Class
Properties
lsxECLOIA Methods
WaitForInputReady
WaitForSystemAvailable
WaitForAppAvailable
WaitForTransition
lsxECLPS Class
Properties
lsxECLPS Methods
SetCursorPos
SendKeys
SearchText
GetText
SetText
GetTextRect
WaitForCursor
WaitWhileCursor
WaitForString
WaitWhileString
WaitForStringInRect
WaitWhileStringInRect
WaitForAttrib
WaitWhileAttrib
WaitForScreen
WaitWhileScreen
lsxECLScreenReco Class
lsxECLScreenReco Methods
IsMatch
lsxECLScreenDesc Class
lsxECLScreenDesc Methods
AddAttrib
AddCursorPos
AddNumFields
AddNumInputFields
AddOIAInhibitStatus
AddString
AddStringInRect
Clear
lsxECLSession Class
Properties
lsxECLSession Methods
lsxECLWinMetrics Class
Properties
lsxECLWinMetrics Methods
GetWindowRect
SetWindowRect
lsxECLXfer Class
Properties
lsxECLXfer Methods
SendFile
ReceiveFile
Host Access Class Library for Java
Appendix A. Sendkeys Mnemonic Keywords
Appendix B. ECL Planes -- Format and Content
TextPlane
FieldPlane
ColorPlane
ExfieldPlane
Appendix C. Notices
Trademarks
Index