Personal Communications for Windows, Version 14.0 IBM Emulator Programming SC31-8478-13 Personal Communications for Windows, Version 14.0 IBM Emulator Programming SC31-8478-13 Note Before using this information and the product it supports, read the information in Appendix F, “Notices,” on page 435. Fourteenth Edition (April 2019) This edition applies to Version 14.0 of IBM Personal Communications for Windows (program number: 5639-I70) and to all subsequent releases and modifications until otherwise indicated in new editions. © Copyright IBM Corporation 1989, 2019. US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. Contents Figures ............... ix Chapter 3. EHLLAPI Functions .... 27 Unicode Support for Code Pages 1390/1399 and Tables ............... xi 1137 ................. 27 Page Layout Conventions.......... 27 About This Book .......... xiii Prerequisite Calls ........... 28 Call Parameters ............ 28 Who Should Read This Book ........ xiii Return Parameters ........... 28 Where To Find More Information ....... xiii Notes on Using This Function ....... 28 Notation ............... xiv Summary of EHLLAPI Functions ....... 28 Allocate Communications Buffer (123) .... 30 Chapter 1. Introduction to Emulator APIs 1 Cancel File Transfer (92) ......... 31 Using API Header Files........... 2 Change PS Window Name (106) ...... 32 Critical Sections ............. 2 Change Switch List LT Name (105) ..... 33 Stack Size ............... 2 Connect for Structured Fields (120) ..... 34 Running 16-bit Windows EHLLAPI programs ... 2 Connect Presentation Space (1) ....... 36 Windows x64 Platform Support ........ 2 Connect Window Services (101)....... 37 Sample Programs ............. 3 Convert Position or Convert RowCol (99) ... 38 Displaying Arabic data in the VBHLLAPI sample Copy Field to String (34) ......... 40 program ............... 4 Copy OIA (13) ............ 48 Copy Presentation Space (5) ........ 57 Chapter 2. Introduction to IBM Standard Copy Presentation Space to String (8)..... 65 EHLLAPI, IBM Enhanced EHLLAPI and Copy String to Field (33) ......... 73 WinHLLAPI Programming ....... 5 Copy String to Presentation Space (15) .... 77 Copy Presentation Space to Clipboard (35) ... 81 EHLLAPI Overviews ........... 5 Paste Clipboard to Presentation Space (36) ... 84 IBM Standard EHLLAPI ......... 5 Disconnect from Structured Fields (121) .... 85 WinHLLAPI ............. 5 Disconnect Presentation Space (2) ...... 86 WinHLLAPI and IBM Standard EHLLAPI ... 5 Disconnect Window Service (102) ...... 87 IBM Enhanced EHLLAPI and IBM Standard EditKey Intercept ........... 88 EHLLAPI .............. 6 Find Field Length (32) .......... 90 Languages ............... 6 Find Field Position (31) ......... 91 EHLLAPI Call Format ........... 6 Free Communications Buffer (124) ...... 93 Data Structures ............. 7 Get Key (51) ............. 94 Memory Allocation ............ 8 Get Request Completion (125) ....... 99 EHLLAPI Return Codes .......... 8 Lock Presentation Space API (60) ...... 102 Compiling and Linking ........... 9 Lock Window Services API (61) ...... 104 Static Link Method ........... 10 Pause (18) ............. 105 Dynamic Link Method.......... 10 Post Intercept Status (52) ........ 107 Multithreading ............ 11 Query Additional Field Attribute (45) .... 108 Presentation Spaces ............ 11 Query Close Intercept (42) ........ 109 IBM Enhanced 32-Bit Interface Presentation Space Query Communications Buffer Size (122) ... 109 IDs ................ 11 Query Communication Event (81) ..... 111 Types of Presentation Spaces........ 11 Query Cursor Location (7) ........ 112 Size of Presentation Spaces ........ 11 Query Field Attribute (14) ........ 112 Presentation Space IDs ......... 12 Query Host Update (24) ......... 114 Host-Connected Presentation Space ..... 12 Query Session Status (22) ........ 115 Presentation Space ID Handling ...... 12 Query Sessions (10) .......... 117 Sharing EHLLAPI Presentation Space between Query System (20) ........... 118 Processes .............. 14 Query Window Coordinates (103) ..... 120 Using mouse actions to select, copy, and paste Read Structured Fields (126) ....... 121 text in the Presentation Space ....... 17 Receive File (91) ........... 126 ASCII Mnemonics ........... 17 Release (12) ............. 128 Debugging ............. 19 Reserve (11) ............. 128 A Simple EHLLAPI Sample Program ..... 19 Reset System (21) ........... 129 Standard and Enhanced Interface Considerations 21 Search Field (30) ........... 130 Host Automation Scenarios ........ 22 Search Presentation Space (6) ....... 134 © Copyright IBM Corp. 1989, 2019 iii Send File (90) ............ 138 Example .............. 202 Send Key (3) ............ 140 pcsQueryWorkstationProfile ........ 202 Set Cursor (40) ............ 151 Function Type ............ 202 Set Session Parameters (9) ........ 152 Parameter Type and Description ...... 202 Start Close Intercept (41) ........ 161 Return Code............. 202 Start Communication Notification (80) .... 163 pcsSetLinkTimeout ........... 203 Start Host Notification (23) ........ 165 Function Prototype .......... 203 Start Keystroke Intercept (50) ....... 168 Parameter Type and Description ...... 203 Start Playing Macro (110) ........ 170 Return Code............. 203 Stop Close Intercept (43)......... 171 pcsStartSession ............. 203 Stop Communication Notification (82) .... 172 Function Type ............ 203 Stop Host Notification (25) ........ 173 Parameter Type and Description ...... 203 Stop Keystroke Intercept (53) ....... 173 Return Code............. 204 Wait (4) .............. 174 pcsStopSession ............. 204 Window Status (104) .......... 175 Function Type ............ 204 Write Structured Fields (127) ....... 178 Parameter Type and Description ...... 204 Return Code............. 204 Chapter 4. WinHLLAPI Extension Page Setup Functions........... 205 Functions ............. 185 Restrictions ............. 205 pcsGetPageSettings .......... 205 Summary of WinHLLAPI Functions ...... 185 pcsRestorePageDefaults ......... 207 WinHLLAPI Asynchronous Functions ..... 185 pcsSetPageSettings .......... 208 WinHLLAPIAsync........... 185 Printer Setup Functions .......... 211 WinHLLAPICancelAsyncRequest ...... 191 Restrictions ............. 211 Initialization and Termination Functions .... 192 pcsGetPrinterSettings .......... 211 WinHLLAPI Startup .......... 192 pcsSetPrinterSettings .......... 216 WinHLLAPI Cleanup.......... 193 Blocking Routines ............ 193 WinHLLAPIIsBlocking ......... 193 Chapter 6. DDE Functions in a 32–bit WinHLLAPISetBlockingHook ....... 193 Environment............ 221 WinHLLAPIUnhookBlockingHook ..... 194 Personal Communications DDE Data Items ... 221 WinHLLAPICancelBlockingCall ...... 194 Using System Topic Data Items ...... 222 Using Session Topic Data Items ...... 222 Chapter 5. PCSAPI Functions .... 197 Using LU Topic Data Items (3270 Only) ... 222 How to Use PCSAPI ........... 197 DDE Functions ............. 223 Page Layout Conventions ......... 197 Naming Conventions for Parameters .... 224 Function Type ............ 197 Code Conversion ............ 224 Parameter Type and Description ...... 197 Conversion Types ........... 224 Return Code............. 197 Personal Communications Response..... 225 pcsConnectSession............ 197 Find Field .............. 226 Function Type ............ 198 CF_DSPTEXT ............ 226 Parameter Type and Description ...... 198 CF_TEXT .............. 226 Return Code............. 198 Personal Communications Response..... 227 pcsDisconnectSession........... 198 Structure of the Field Information ..... 227 Function Type ............ 198 Get Keystrokes ............. 228 Parameter Type and Description ...... 198 Personal Communications Response..... 229 Return Code............. 198 Structure of the Keystroke Information .... 229 pcsQueryConnectionInfo ......... 199 Get Mouse Input ............ 229 Function Type ............ 199 Personal Communications Response..... 230 Parameter Type and Description ...... 199 Structure of the Mouse Input Information ... 230 Return Code............. 199 Get Number of Close Requests ....... 232 ConnectionInfo ............ 199 Personal Communications Response..... 232 Example .............. 199 Structure of the Number of the Close Requests pcsQueryEmulatorStatus ......... 200 Information ............. 233 Function Type ............ 200 Get Operator Information Area ....... 233 Parameter Type and Description ...... 200 Personal Communications Response..... 233 Return Code............. 200 Structure of the Operator Information Area .. 234 pcsQuerySessionList ........... 200 Get Partial Presentation Space ........ 234 Function Type ............ 201 Personal Communications Response..... 234 Parameter Type and Description ...... 201 Structure of the Presentation Space ..... 235 Return Parameters........... 201 Get Presentation Space .......... 236 Personal Communications Response..... 237 iv Emulator Programming Structure of the Presentation Space ..... 237 Personal Communications Response..... 273 Get Session Status ............ 238 Stop Keystroke Intercept.......... 274 Personal Communications Response..... 239 Personal Communications Response..... 274 Format of Status Information ....... 239 Stop Mouse Input Intercept......... 274 Get System Configuration ......... 240 Personal Communications Response..... 275 Personal Communications Response..... 240 Stop Read SF ............. 275 Format of System Configuration Information