XPORT Programmer's Guide

Company:Digital Equipment Corporation
Part:AA-J201A-TK
Date:1981-04
Keywords:BLISS VAX/VMS TOPS-10 TOPS-20

Table of Contents

  • Chapter 1 Introduction
    • 1.1 Applicability of XPORT Facilities
    • 1.2 Program Transportability
    • 1.3 File Transportability
    • 1.4 Symbol Naming Conventions
    • 1.5 Compilation Error Messages
    • 1.6 Small Sample Program
  • Chapter 2 Transportable Data Structures
    • 2.1 Introduction
      • 2.1.1 The Problem
      • 2.1.2 The Solution
      • 2.1.3 Simple Example
      • 2.1.4 Terminology
    • 2.2 $FIELD Declaration and $FIELD_SET_SIZE
      • 2.2.1 $FIELD Declaration
      • 2.2.2 Transportable Field-Types
      • 2.2.3 Nontransportable Field-Types
      • 2.2.4 Guidelines for Individual Field-Types
      • 2.2.5 $FIELD_SET_SIZE Usage
    • 2.3 Supplementary Features
      • 2.3.1 Field-Positioning Features
      • 2.3.2 Literal-Defining Features
      • 2.3.3 Value-Display Feature
      • 2.3.4 Subfield Referencing Feature
    • 2.4 Transportability Concerns
      • 2.4.1 Field Size
      • 2.4.2 Integer Value Range
      • 2.4.3 Use of $BYTES for Character Strings
    • 2.5 Efficiency Concerns
  • Chapter 3 Input/Output Facilities
    • 3.1 Introduction
      • 3.1.1 General Characteristics
      • 3.1.2 Specific Functions
    • 3.2 Capabilities
      • 3.2.1 File Level Capabilities
      • 3.2.2 Input/Output Capabilities
      • 3.2.3 File Specification Resolution
    • 3.3 I/O Related Macros
      • 3.3.1 General Format and Common Parameters
      • 3.3.2 File-Level Macros
      • 3.3.3 Input/Output Macros
    • 3.4 Input/Output Control Blocks
      • 3.4.1 Creating and Initializing IOBs
      • 3.4.2 Using IOB Fields and Values
    • 3.5 Standard I/O Devices
    • 3.6 File Specification Processing
      • 3.6.1 File Specification Resolution
      • 3.6.2 File Specification Parsing
    • 3.7 I/O Completion Codes
    • 3.8 I/O Action Routines
  • Chapter 4 Memory Management Facilities
    • 4.1 Introduction
    • 4.2 Capabilities
    • 4.3 Memory Management Macros
      • 4.3.1 $XPO_GET_MEM - Allocating Dynamic Memory
      • 4.3.2 $XPO_FREE_MEM - Releasing Dynamic Memory
      • 4.3.3 Dynamic Memory Elements
    • 4.4 Completion Codes
    • 4.5 Action Routines
  • Chapter 5 Other System Services
    • 5.1 Introduction
    • 5.2 $XPO_PUT_MSG
      • 5.2.1 Completion Codes
      • 5.2.2 Action Routines
    • 5.3 $XPO_TERMINATE
  • Chapter 6 String Handling Facilities
    • 6.1 String Descriptors
      • 6.1.1 $STR_DESCRIPTOR -- Creating a String Descriptor
      • 6.1.2 $STR_DESCRIPTOR -- Compile-Time Descriptor Initialization
      • 6.1.3 $STR_DESC_INIT -- Run-Time String Descriptor Initialization
      • 6.1.4 String Descriptor Formats
      • 6.1.5 String Descriptor Usage Rules
      • 6.1.6 Descriptor Data Types
    • 6.2 String Descriptor Structure References
    • 6.3 String Modification
      • 6.3.1 $STR_COPY Operation
      • 6.3.2 $STR_APPEND Operation
    • 6.4 String Comparison
    • 6.5 String Scanning
      • 6.5.1 $STR_SCAN Overview
      • 6.5.2 $STR_SCAN FIND - Find a Character Sequence
      • 6.5.3 $STR_SCAN SPAN - Match a Set of Characters
      • 6.5.4 $STR_SCAN STOP - Search for a Set of Characters
      • 6.5.5 $STR_SCAN - Returning a Substring
      • 6.5.6 $STR_SCAN - "Scanning Through" a BOUNDED String
    • 6.6 String Conversion
      • 6.6.1 $STR_CONCAT and $STR_FORMAT - ASCII to ASCII String Conversions
      • 6.6.2 $STR_ASCII - Binary-Data to ASCII String Conversion
      • 6.6.3 Nesting $STR_ASCII, $STR_CONCAT, $STR_FORMAT Pseudo-Functions
      • 6.6.4 $STR_BINARY - ASCII String to Binary-Data Conversion
  • Chapter 7 Binary Data Descriptors
    • 7.1 Introduction
    • 7.2 Binary Data Descriptor Creation and Initialization
      • 7.2.1 $XPO_DESCRIPTOR -- Creating a Binary Data Descriptor
      • 7.2.2 $XPO_DESCRIPTOR -- Compile-Time Descriptor Initialization
      • 7.2.3 $XPO_DESC_INIT -- Run-Time Data Descriptor Initialization
      • 7.2.4 Classes Of Descriptors
  • Appendix A Macro Descriptions
    • A.1 Descriptive Notation and Conventions
      • A.1.1 Syntax Notation
      • A.1.2 Character-String and Binary-Data Parameters
    • A.2 $STR_APPEND - Append a String
      • A.2.1 Syntax
      • A.2.2 Restrictions
      • A.2.3 Parameter Semantics
      • A.2.4 Operational Semantics
      • A.2.5 Completion Codes
    • A.3 $STR_ASCII - Binary-to-ASCII Conversion Pseudo-Function
      • A.3.1 Syntax
      • A.3.2 Restrictions
      • A.3.3 Parameter Semantics
      • A.3.4 Usage Guidelines
    • A.4 $STR_BINARY - Convert ASCII to Binary
      • A.4.1 Syntax
      • A.4.2 Restrictions
      • A.4.3 Parameter Semantics
      • A.4.4 Usage Guidelines
      • A.4.5 Completion Codes
    • A.5 $STR_COMPARE - String Comparison
      • A.5.1 Syntax
      • A.5.2 Restrictions
      • A.5.3 Parameter Semantics
      • A.5.4 Operational Semantics
      • A.5.5 Completion Codes
    • A.6 $STR_CONCAT - String Concatenation Pseudo-Function
      • A.6.1 Syntax
      • A.6.2 Restrictions
      • A.6.3 Parameter Semantics
      • A.6.4 Usage Guidelines
    • A.7 $STR_COPY - Copy a String
      • A.7.1 Syntax
      • A.7.2 Restrictions
      • A.7.3 Parameter Semantics
      • A.7.4 Operational Semantics
      • A.7.5 Completion Codes
    • A.8 $STR_DESCRIPTOR - Declare a String Descriptor
      • A.8.1 Syntax
      • A.8.2 Restrictions
      • A.8.3 Parameter Semantics
    • A.9 $STR_DESC_INIT - Initialize a String Descriptor
      • A.9.1 Syntax
      • A.9.2 Restrictions
      • A.9.3 Parameter Semantics
      • A.9.4 Completion Code
    • A.10 $STR_EQL - String Equality Comparison
      • A.10.1 Syntax
      • A.10.2 Restrictions
      • A.10.3 Parameter Semantics
      • A.10.4 Operational Semantics
      • A.10.5 Completion Codes
    • A.11 $STR_FORMAT - String Formatting Pseudo-Function
      • A.11.1 Syntax
      • A.11.2 Restrictions
      • A.11.3 Parameter Semantics
      • A.11.4 Usage Guidelines
    • A.12 $STR_GEQ - String Greater-Than-or-Equal Comparison
      • A.12.1 Syntax
      • A.12.2 Restrictions
      • A.12.3 Parameter Semantics
      • A.12.4 Operational Semantics
      • A.12.5 Completion Codes
    • A.13 $STR_GTR - String Greater-Than Comparison
      • A.13.1 Syntax
      • A.13.2 Restrictions
      • A.13.3 Parameter Semantics
      • A.13.4 Operational Semantics
      • A.13.5 Completion Codes
    • A.14 $STR_LEQ - String Less-Than-or-Equal Comparison
      • A.14.1 Syntax
      • A.14.2 Restrictions
      • A.14.3 Parameter Semantics
      • A.14.4 Operational Semantics
      • A.14.5 Completion Codes
    • A.15 $STR_LSS - String Less-Than Comparison
      • A.15.1 Syntax
      • A.15.2 Restrictions
      • A.15.3 Parameter Semantics
      • A.15.4 Operational Semantics
      • A.15.5 Completion Codes
    • A.16 $STR_NEQ - String Inequality Comparison
      • A.16.1 Syntax
      • A.16.2 Restrictions
      • A.16.3 Parameter Semantics
      • A.16.4 Operational Semantics
      • A.16.5 Completion Codes
    • A.17 $STR_SCAN - String Scanning
      • A.17.1 Syntax
      • A.17.2 Restrictions
      • A.17.3 Parameter Semantics
      • A.17.4 Operational Semantics
      • A.17.5 Completion Codes
    • A.18 $XPO_BACKUP - Preserve an Input File
      • A.18.1 Syntax
      • A.18.2 Parameter Semantics
      • A.18.3 Usage Guidelines
      • A.18.4 Completion Codes
      • A.18.5 Example
    • A.19 $XPO_CLOSE - Close a File
      • A.19.1 Syntax
      • A.19.2 Parameter Semantics
      • A.19.3 Usage Guidelines
      • A.19.4 Completion Codes
    • A.20 $XPO_DELETE - Delete a File
      • A.20.1 Syntax
      • A.20.2 Parameter Semantics
      • A.20.3 Completion Codes
    • A.21 $XPO_DESCRIPTOR - Declare a Data Descriptor
      • A.21.1 Syntax
      • A.21.2 Restrictions
      • A.21.3 Parameter Semantics
    • A.22 $XPO_DESC_INIT - Initialize a Data Descriptor
      • A.22.1 Syntax
      • A.22.2 Parameter Semantics
      • A.22.3 Completion Code
    • A.23 $XPO_FREE_MEM - Release a Memory Element
      • A.23.1 Syntax
      • A.23.2 Restrictions
      • A.23.3 Parameter Restrictions
      • A.23.4 Completion Codes
    • A.24 $XPO_GET - Read From a File
      • A.24.1 Syntax
      • A.24.2 Paramter Semantics
      • A.24.3 Usage Guidelines
      • A.24.4 Completion Codes
    • A.25 $XPO_GET_MEM - Allocate Dynamic Memory Element
      • A.25.1 Syntax
      • A.25.2 Restrictions
      • A.25.3 Parameter Semantics
      • A.25.4 Completion Codes
    • A.26 $XPO_IOB - Declare an IOB
      • A.26.1 Syntax
      • A.26.2 Parameter Semantics
      • A.26.3 Examples
    • A.27 $XPO_IOB_INIT - Initialize an IOB
      • A.27.1 Syntax
      • A.27.2 Restrictions
      • A.27.3 Parameter Semantics
      • A.27.4 Completion Code
    • A.28 $XPO_OPEN - Open a File
      • A.28.1 Syntax
      • A.28.2 Parameter Semantics
      • A.28.3 Completion Codes
    • A.29 $XPO_PARSE_SPEC - Parse a File Specification
      • A.29.1 Syntax
      • A.29.2 Parameter Semantics
      • A.29.3 Completion Codes
    • A.30 $XPO_PUT - Write to a File
      • A.30.1 Syntax
      • A.30.2 Restrictions
      • A.30.3 Parameter Semantics
      • A.30.4 Usage Guidelines
      • A.30.5 Completion Codes
    • A.31 $XPO_PUT_MSG - Send a Message
      • A.31.1 Syntax
      • A.31.2 Parameter Semantics
      • A.31.3 Completion Codes
    • A.32 $XPO_RENAME - Rename a File
      • A.32.1 Syntax
      • A.32.2 Parameter Semantics
      • A.32.3 Completion Codes
    • A.33 $XPO_SPEC_BLOCK - Declare a File Specification Block
      • A.33.1 Syntax
      • A.33.2 Examples
    • A.34 $XPO_TERMINATE - Terminate Program Execution
      • A.34.1 Syntax
      • A.34.2 Parameter Semantics
      • A.34.3 Routine Value
  • Appendix B Control Blocks
    • B.1 Input/Output Block (IOB)
    • B.2 String Descriptors
    • B.3 Binary Data Descriptors
    • B.4 File Specification Parse Block
  • Appendix C Completion Codes
  • Appendix D Sample Program
  • Appendix E Action Routines
    • E.1 Action-Routine Calls and Returns
      • E.1.1 Action Routine Calls
      • E.1.2 Action Routine Return Values
    • E.2 XFAIL.BLI Failure-Action Routine Listing
    • E.3 SFAIL.BLI Failure-Action Routine Listing
  • Appendix F Compiling and Linking
    • F.1 Defining a Transportable Logical Device
    • F.2 Compiling
    • F.3 Linking
  • Appendix G XDUMP Utility Program
    • G.1 XDUMP - XPORT Data Structure Display Utility
      • G.1.1 Running the XDUMP Utility
      • G.1.2 Compiling a Structure Display Module
      • G.1.3 Linking a Structure Display Module
      • G.1.4 Displaying a User Declared Structure While Debugging
    • G.2 XDESC, XIOB, and XSPEC - XPORT Structure Display Modules
      • G.2.1 Linking an XPORT Structure Display Module
      • G.2.2 Displaying an XPORT Structure While Debugging
  • Appendix Z Easy-To-Use I/O Package (EZIO)
    • Z.1 Overview
    • Z.2 Limitations
    • Z.3 Functional Description
      • Z.3.1 The FILOPN Routine
      • Z.3.2 The FILIN Routine
      • Z.3.3 The FILOUT Routine
      • Z.3.4 The FILCLS Routine
      • Z.3.5 Restrictions
      • Z.3.6 Example
    • Z.4 Loading EZIO With User Program
      • Z.4.1 EZIOFC - File Services 11 (RSX-11M)
      • Z.4.2 EZIORT - RT-11
      • Z.4.3 EZIO10 - TOPS-10
      • Z.4.4 EZIO20 - TOPS-20
      • Z.4.5 EZIOVX - VAX/VMS
    • Z.5 Packaging

Copies

Address: http://bitsavers.org/pdf/dec/pdp10/TOPS10_softwareNotebooks/vol08/AA-J201A-TK_XPORT_Programmers_Guide_Apr81.pdf
Site: Al Kossow's Bitsavers
Format: PDF
Size: 11749440 bytes (11.2 MiB)
MD5: 499df431755ced378839a2138e88268e
Mirrors: