|
|
|
EXTRA! Developer Tools: API Code Samples and Manuals
Technical Note 2164
Last Reviewed 28-Mar-2007
Applies To
EXTRA! X-treme version 8.0 or higher
myEXTRA! Enterprise
EXTRA! Enterprise 2000
EXTRA! Personal Client
Summary
Technical Note 2164
Last Reviewed 28-Mar-2007
Applies To
EXTRA! X-treme version 8.0 or higher
myEXTRA! Enterprise
EXTRA! Enterprise 2000
EXTRA! Personal Client
Summary
This technical note provides information on EXTRA! application programming interfaces (APIs), including code samples and programming reference manuals.
API Information for EXTRA! Products
This technical note is organized into the following sections:
Simple Functionality Code Samples
API Reference Manuals
EXTRA! Basic Code Samples
Test Tool Code Samples
API Reference Manuals
EXTRA! Basic Code Samples
Test Tool Code Samples
Simple Functionality Code Samples
The following code samples are provided to illustrate basic functionality. Each code sample includes function calls that perform the same four tasks:
- Connect to a host session
- Capture data
- Send keystrokes to the host.
- Disconnect host session
- Capture data
- Send keystrokes to the host.
- Disconnect host session
To use these code samples:
- Download the appropriate sample for your particular integrated development environment (IDE) and desired API.
Note: Typically, the OLE Automation API is recommended for new application development. (Other API information is provided as reference for existing legacy applications.)
- Run the downloaded .exe file on a Windows system to unzip it. (You will be prompted to accept the agreement and enter a destination directory.)
- See the unzipped Readme.txt file for further instructions.
| |
EXTRA! Basic |
Visual Basic .NET / 6.0 |
Visual C# .NET |
Visual C++ .NET / 6.0 |
| OLE Automation (COM) |
ole32eb.exe |
ole32vbn.exe, ole32vb6.exe |
ole32vcs.exe |
ole32cpp.exe, ole32vc6.exe |
| WinHLLAPI |
whl32eb.exe |
whl32vbn.exe, whl32vb6.exe |
whl32vcs.exe |
whl32cpp.exe, whl32vc6.exe |
| EHLLAPI |
ehl32eb.exe |
ehl32vbn.exe, ehl32vb6.exe |
ehl32vcs.exe |
ehl32cpp.exe, ehl32vc6.exe |
| Attachmate HLLAPI |
hll32eb.exe |
hll32vbn.exe, hll32vb6.exe |
hll32vcs.exe |
hll32cpp.exe, hll32vc6.exe |
| EAL |
eal32eb.exe |
eal32vbn.exe, eal32vb6.exe |
eal32vcs.exe |
eal32cpp.exe, eal32vc6.exe |
| PCSHLL |
pcs32eb.exe |
pcs32vbn.exe, pcs32vb6.exe |
pcs32vcs.exe |
pcs32cpp.exe, pcs32vc6.exe |
| WD_API |
wdapieb.exe |
wdapivbn.exe, wdapivb6.exe |
wdapivcs.exe |
wdapivc6.exe |
API Reference Manuals
The following documentation is available for EXTRA! APIs.
| API |
Reference Information |
| OLE Automation (COM) |
See the EXTRA! Macro Editor component help (installed with product), or EPC_OLE.HLP as described in Technical Note 2271. |
| WinHLLAPI |
WinHLLAPI Language Reference http://docs.attachmate.com/extra/x-treme/APIs/whllapi.pdf |
| EHLLAPI |
EHLLAPI Language Reference http://docs.attachmate.com/extra/x-treme/APIs/ehllapi.pdf |
| Attachmate HLLAPI |
HLLAPI Language Reference http://docs.attachmate.com/extra/x-treme/APIs/hllapi.pdf |
| EAL |
Enterprise Access Library Language Reference http://docs.attachmate.com/extra/x-treme/APIs/eal.pdf |
| PCSHLL |
PCSHLL Language Reference (IBM PCOMM 4.01 EHLLAPI) http://docs.attachmate.com/extra/x-treme/APIs/pcshll.pdf |
| WD_API |
Wall Data (RUMBA) WD_API Language Reference http://docs.attachmate.com/extra/x-treme/APIs/wd_api.pdf |
EXTRA! Basic Code Samples
A collection of over 20 EXTRA! Basic macros is available for download. These educational samples demonstrate:
- displaying Windows dialogs,
- checking the host 3270 OIA status line,
- transferring a file at a regular interval,
- calling Win32 API functions (e.g., modify Windows registry),
- copying host screen text to a Microsoft Excel spreadsheet,
- and more.
- checking the host 3270 OIA status line,
- transferring a file at a regular interval,
- calling Win32 API functions (e.g., modify Windows registry),
- copying host screen text to a Microsoft Excel spreadsheet,
- and more.
Download eb-samples.zip and see the enclosed _ReadMe.txt file for more information.
Test Tool Code Samples
The following additional test tool code samples are available for older APIs and IDEs.
| |
VB 5.0 / 6.0 |
VC++ 5.0 / 6.0 |
| WinHLLAPI |
hllvb32w.exe |
hlltes32.exe |
| EHLLAPI |
hllvb32e.exe |
hlltes32.exe |
| HLLAPI |
- |
hlldem32.exe |
| EAL |
atmapi32.exe |
ealtutor.exe |
| PCSHLL |
- |
pcshll32.exe |
By default, EXTRA! X-treme is configured to use 32-bit Enhanced Transport for HLLAPI. You can confirm the HLLAPI Transport Type selection by clicking Options > Global Preferences > Advanced.
For information on tracing API calls for debugging purposes, see Technical Note 2249.
