SNAP-IX HLLAPI Programmer's Guide

• Before You Begin
  • Intended Audience
  • Prerequisite Knowledge
  • About This Book
    • Organization of This Book
    • Typographic Conventions
  • Common Abbreviations
  • SNAP-IX Publications
    • Publications for Users
    • Publications for Administrators
    • Publications for Programmers
  • SNAP-IX TN3270 Publications
  • Related Publications
• 1 Introducing HLLAPI
  • 1.1 What Is HLLAPI?
  • 1.2 How HLLAPI Works
  • 1.3 Typical Uses of HLLAPI
    • 1.3.1 Automating Startup of Host 3270 Applications
    • 1.3.2 Simplifying Host 3270 Applications
    • 1.3.3 Accessing Host Applications Designed for Large Screen Models
• 2 Programming in the 3270 Environment
  • 2.1 Using the 3270 Presentation Space
    • 2.1.1 Presentation Space Sizes
    • 2.1.2 Screen Buffer
    • 2.1.3 Converting Row and Column Coordinates
  • 2.2 Fields in the Presentation Space
    • 2.2.1 Working with Unformatted Presentation Spaces
    • 2.2.2 Working with Formatted Presentation Spaces
    • 2.2.3 Field Attributes
    • 2.2.4 Locating Fields
    • 2.2.5 Auto-Skip Fields
    • 2.2.6 Detecting Modified Fields
  • 2.3 Extended Attributes
    • 2.3.1 Extended Field Attributes
    • 2.3.2 Extended Character Attributes
    • 2.3.3 Relationship of Extended Attributes to Field Attributes
    • 2.3.4 Base Colors
    • 2.3.5 Attribute Bytes Returned to HLLAPI Applications
• 3 Writing Application Programs
  • 3.1 General Guidelines
  • 3.2 Programming Host Transactions
    • 3.2.1 Sending Data to the Host Program
    • 3.2.2 Waiting for Host Responses
  • 3.3 Using HLLAPI Functions in C Programs
    • 3.3.1 Declarations
    • 3.3.2 Data String Size
    • 3.3.3 Initializing Function Parameters
    • 3.3.4 Requesting a Function
    • 3.3.5 Accessing Values from Returned Data Strings
  • 3.4 Multiple Processes and Multiple Threads
  • 3.5 Use of Signals
  • 3.6 Compiling and Linking the HLLAPI Application
  • 3.7 Running the HLLAPI Application
  • 3.8 Writing Portable Applications
  • 3.9 Fast Path Checklist
• 4 HLLAPI Function Requests
  • 4.1 Note on Data String Formats
  • 4.2 Function Information
    • 4.2.1 Function Number and Symbolic Name
    • 4.2.2 Prior Functions
    • 4.2.3 Request Parameters
    • 4.2.4 Returned Parameters
    • 4.2.5 Affected by Set Session Parameters?
    • 4.2.6 Usage and Restrictions
    • 4.2.7 Additional Information
  • 4.3 Alphabetical Listing
  • 4.4 Connect Presentation Space
    • 4.4.1 Prior Functions
    • 4.4.2 Request Parameters
    • 4.4.3 Returned Parameters
    • 4.4.4 Affected by Set Session Parameters?
    • 4.4.5 Usage and Restrictions
  • 4.5 Convert Position or RowCol
    • 4.5.1 Prior Functions
    • 4.5.2 Request Parameters
    • 4.5.3 Returned Parameters
    • 4.5.4 Affected by Set Session Parameters?
    • 4.5.5 Usage and Restrictions
  • 4.6 Copy Field to String
    • 4.6.1 Prior Functions
    • 4.6.2 Request Parameters
    • 4.6.3 Returned Parameters
    • 4.6.4 Affected by Set Session Parameters?
    • 4.6.5 Usage and Restrictions
  • 4.7 Copy OIA
    • 4.7.1 Prior Functions
    • 4.7.2 Request Parameters
    • 4.7.3 Returned Parameters
    • 4.7.4 Affected by Set Session Parameters?
  • 4.8 Copy Presentation Space
    • 4.8.1 Prior Functions
    • 4.8.2 Request Parameters
    • 4.8.3 Returned Parameters
    • 4.8.4 Affected by Set Session Parameters?
    • 4.8.5 Usage and Restrictions
  • 4.9 Copy Presentation Space to String
    • 4.9.1 Prior Functions
    • 4.9.2 Request Parameters
    • 4.9.3 Returned Parameters
    • 4.9.4 Affected by Set Session Parameters?
    • 4.9.5 Usage and Restrictions
  • 4.10 Copy String to Field
    • 4.10.1 Prior Functions
    • 4.10.2 Request Parameters
    • 4.10.3 Returned Parameters
    • 4.10.4 Affected by Set Session Parameters?
    • 4.10.5 Usage and Restrictions
  • 4.11 Copy String to Presentation Space
    • 4.11.1 Prior Functions
    • 4.11.2 Request Parameters
    • 4.11.3 Returned Parameters
    • 4.11.4 Affected by Set Session Parameters?
    • 4.11.5 Usage and Restrictions
  • 4.12 Disconnect Presentation Space
    • 4.12.1 Prior Functions
    • 4.12.2 Request Parameters
    • 4.12.3 Returned Parameters
    • 4.12.4 Affected by Set Session Parameters?
    • 4.12.5 Usage and Restrictions
  • 4.13 Display Attribute
    • 4.13.1 Prior Functions
    • 4.13.2 Request Parameters
    • 4.13.3 Returned Parameters
    • 4.13.4 Affected by Set Session Parameters?
    • 4.13.5 Usage and Restrictions
  • 4.14 Display Off
    • 4.14.1 Prior Functions
    • 4.14.2 Request Parameters
    • 4.14.3 Returned Parameters
    • 4.14.4 Affected by Set Session Parameters?
    • 4.14.5 Usage and Restrictions
  • 4.15 Display On
    • 4.15.1 Prior Functions
    • 4.15.2 Request Parameters
    • 4.15.3 Returned Parameters
    • 4.15.4 Affected by Set Session Parameters?
    • 4.15.5 Usage and Restrictions
  • 4.16 Display Text
    • 4.16.1 Prior Functions
    • 4.16.2 Request Parameters
    • 4.16.3 Returned Parameters
    • 4.16.4 Affected by Set Session Parameters?
    • 4.16.5 Usage and Restrictions
  • 4.17 Find Field Length
    • 4.17.1 Prior Functions
    • 4.17.2 Request Parameters
    • 4.17.3 Returned Parameters
    • 4.17.4 Affected by Set Session Parameters?
    • 4.17.5 Usage and Restrictions
  • 4.18 Find Field Position
    • 4.18.1 Prior Functions
    • 4.18.2 Request Parameters
    • 4.18.3 Returned Parameters
    • 4.18.4 Affected by Set Session Parameters?
    • 4.18.5 Usage and Restrictions
  • 4.19 Get Key
    • 4.19.1 Prior Functions
    • 4.19.2 Request Parameters
    • 4.19.3 Returned Parameters
    • 4.19.4 Affected by Set Session Parameters?
    • 4.19.5 Usage and Restrictions
    • 4.19.6 Data String Format
  • 4.20 Pause
    • 4.20.1 Prior Functions
    • 4.20.2 Request Parameters
    • 4.20.3 Returned Parameters
    • 4.20.4 Affected by Set Session Parameters?
    • 4.20.5 Usage and Restrictions
  • 4.21 Post Intercept Status
    • 4.21.1 Prior Functions
    • 4.21.2 Request Parameters
    • 4.21.3 Returned Parameters
    • 4.21.4 Affected by Set Session Parameters?
    • 4.21.5 Usage and Restrictions
  • 4.22 Query Cursor Location
    • 4.22.1 Prior Functions
    • 4.22.2 Request Parameters
    • 4.22.3 Returned Parameters
    • 4.22.4 Affected by Set Session Parameters?
  • 4.23 Query Field Attribute
    • 4.23.1 Prior Functions
    • 4.23.2 Request Parameters
    • 4.23.3 Returned Parameters
    • 4.23.4 Affected by Set Session Parameters?
    • 4.23.5 Usage and Restrictions
  • 4.24 Query Host Update
    • 4.24.1 Prior Functions
    • 4.24.2 Request Parameters
    • 4.24.3 Returned Parameters
    • 4.24.4 Affected by Set Session Parameters?
    • 4.24.5 Usage and Restrictions
  • 4.25 Query Session Status
    • 4.25.1 Prior Functions
    • 4.25.2 Request Parameters
    • 4.25.3 Returned Parameters
    • 4.25.4 Affected by Set Session Parameters?
  • 4.26 Query Sessions
    • 4.26.1 Prior Functions
    • 4.26.2 Request Parameters
    • 4.26.3 Returned Parameters
    • 4.26.4 Affected by Set Session Parameters?
    • 4.26.5 Usage and Restrictions
  • 4.27 Query System
    • 4.27.1 Prior Functions
    • 4.27.2 Request Parameters
    • 4.27.3 Returned Parameters
    • 4.27.4 Affected by Set Session Parameters?
    • 4.27.5 Usage and Restrictions
  • 4.28 Receive File
    • 4.28.1 Prior Functions
    • 4.28.2 Request Parameters
    • 4.28.3 Returned Parameters
    • 4.28.4 Affected by Set Session Parameters?
    • 4.28.5 Usage and Restrictions
  • 4.29 Release
    • 4.29.1 Prior Functions
    • 4.29.2 Request Parameters
    • 4.29.3 Returned Parameters
    • 4.29.4 Affected by Set Session Parameters?
    • 4.29.5 Usage and Restrictions
  • 4.30 Reserve
    • 4.30.1 Prior Functions
    • 4.30.2 Request Parameters
    • 4.30.3 Returned Parameters
    • 4.30.4 Affected by Set Session Parameters?
    • 4.30.5 Usage and Restrictions
  • 4.31 Reset System
    • 4.31.1 Prior Functions
    • 4.31.2 Request Parameters
    • 4.31.3 Returned Parameters
    • 4.31.4 Affected by Set Session Parameters?
    • 4.31.5 Usage and Restrictions
  • 4.32 Search Field
    • 4.32.1 Prior Functions
    • 4.32.2 Request Parameters
    • 4.32.3 Returned Parameters
    • 4.32.4 Affected by Set Session Parameters?
    • 4.32.5 Usage and Restrictions
  • 4.33 Search Presentation Space
    • 4.33.1 Prior Functions
    • 4.33.2 Request Parameters
    • 4.33.3 Returned Parameters
    • 4.33.4 Affected by Set Session Parameters?
    • 4.33.5 Usage and Restrictions
  • 4.34 Send File
    • 4.34.1 Prior Functions
    • 4.34.2 Request Parameters
    • 4.34.3 Returned Parameters
    • 4.34.4 Affected by Set Session Parameters?
    • 4.34.5 Usage and Restrictions
  • 4.35 Send Key
    • 4.35.1 Prior Functions
    • 4.35.2 Request Parameters
    • 4.35.3 Returned Parameters
    • 4.35.4 Affected by Set Session Parameters?
    • 4.35.5 Usage and Restrictions
    • 4.35.6 Keyboard Mnemonics
  • 4.36 Set Cursor
    • 4.36.1 Prior Functions
    • 4.36.2 Request Parameters
    • 4.36.3 Returned Parameters
    • 4.36.4 Affected by Set Session Parameters?
  • 4.37 Set Session Parameters
    • 4.37.1 Prior Functions
    • 4.37.2 Request Parameters
    • 4.37.3 Returned Parameters
    • 4.37.4 Usage and Restrictions
    • 4.37.5 Attribute Copy Options
    • 4.37.6 Connect Options
    • 4.37.7 Copy Options
    • 4.37.8 End-of-Text Copy Options
    • 4.37.9 Escape Option
    • 4.37.10 Extended Session ID Options
    • 4.37.11 Pause Options
    • 4.37.12 Quiet Options
    • 4.37.13 Reset Options
    • 4.37.14 Search Options
    • 4.37.15 Timeout Options
    • 4.37.16 Trace Options
    • 4.37.17 Wait Options
  • 4.38 Start Host Notification
    • 4.38.1 Prior Functions
    • 4.38.2 Request Parameters
    • 4.38.3 Returned Parameters
    • 4.38.4 Affected by Set Session Parameters?
    • 4.38.5 Usage and Restrictions
  • 4.39 Start Keystroke Intercept
    • 4.39.1 Prior Functions
    • 4.39.2 Request Parameters
    • 4.39.3 Returned Parameters
    • 4.39.4 Affected by Set Session Parameters?
    • 4.39.5 Usage and Restrictions
  • 4.40 Stop Host Notification
    • 4.40.1 Prior Functions
    • 4.40.2 Request Parameters
    • 4.40.3 Returned Parameters
    • 4.40.4 Affected by Set Session Parameters?
    • 4.40.5 Usage and Restrictions
  • 4.41 Stop Keystroke Intercept
    • 4.41.1 Prior Functions
    • 4.41.2 Request Parameters
    • 4.41.3 Returned Parameters
    • 4.41.4 Affected by Set Session Parameters?
  • 4.42 Storage Manager
    • 4.42.1 Storage Manager Subfunction 1: Get Storage
    • 4.42.2 Storage Manager Subfunction 2: Free Storage
    • 4.42.3 Storage Manager Subfunction 3: Query Free Storage
    • 4.42.4 Storage Manager SubFunction 4 : Free All Storage
  • 4.43 Wait
    • 4.43.1 Prior Functions
    • 4.43.2 Request Parameters
    • 4.43.3 Returned Parameters
    • 4.43.4 Affected by Set Session Parameters?
    • 4.43.5 Usage and Restrictions
• 5 Sample HLLAPI Program
  • 5.1 Overview
    • 5.1.1 Display Functions
  • 5.2 Compiling, Linking, and Running the Sample Program
• Appendix A: Presentation Space Sizes
  • A.1 Model 2
  • A.2 Model 3
  • A.3 Model 4
  • A.4 Model 5
• Appendix B: OIA Image Information
• Index