Table of Contents

Search

  1. Preface
  2. PowerExchange Navigator Introduction
  3. Data Maps
  4. Data Maps for Specific Data Sources
  5. Copybooks
  6. Registration Groups and Capture Registrations
  7. Extraction Groups and Extraction Maps
  8. Personal Metadata
  9. Database Row Test
  10. PowerExchange Navigator Examples
  11. Appendix A: PowerExchange Functions for User-Defined Fields
  12. Appendix B: User Access Method Programs
  13. Appendix C: Application Groups and Applications
  14. Appendix D: Data Map Properties
  15. Appendix E: Record, Field, and Table Properties
  16. Appendix F: DTL__CAPXTIMESTAMP Time Stamps
  17. Appendix G: Trace for Creating a Memory Map When Importing a COBOL Copybook

Navigator User Guide

Navigator User Guide

Parameter Structure Passed to the User Access Method Program

Parameter Structure Passed to the User Access Method Program

The PowerExchange Navigator provides a single parameter that locates the parameter structure.
The following table describes the parameter structure passed to the user access method program:
Variable Name
Description
Corresponding Field in the PowerExchange Navigator GUI
Type
Size
LGMODE
Used in connection with a value of 1 in the LGCODE variable, and indicates how the data file is opened, as follows:
  • 1. Read.
  • 2. Write.
  • 3. Update.
  • 4. Append.
Not applicable
Binary
Word
LGCODE
Indicates the function to be performed by the user access method program, as follows:
  • 1. Open.
  • 2. Close.
  • 3. Read.
  • 4. Write.
Not applicable
Binary
Word
LGUI1
User-defined parameter, which can be used to provide numeric information such as the record length or the number of rows to be retrieved.
Integer 1
value in the
USER Access Method
dialog box
Binary
Word
LGUI2
User-defined parameter, which can be used to provide numeric information such as the record length or the number of rows to be retrieved.
Integer 2
value in the
USER Access Method
dialog box
Binary
Word
LGREADCT
The number of records read from the data file.
Not applicable
Binary
Word
LGWRITCT
The number of records written to the data file.
Not applicable
Binary
Word
LGMLRECL
The record length of the retrieved data.
Set by the user access method program
Binary
Word
LGU1LEN
The length of the data entered in the
String 1
box in the
USER Access Method
dialog box.
Derived from the
String 1
value in the
USER Access Method
dialog box
Binary
Word
LGU2LEN
The length of the data entered in the
String 2
box in the
USER Access Method
dialog box.
Derived from the
String 2
value in the
USER Access Method
dialog box
Binary
Word
LGFNLEN
The length of the data file name entered in the
File Name
box in the
USER Access Method
dialog box.
Derived from the
File Name
value in the
USER Access Method
dialog box
Binary
Word
LGUIDLEN
The length of the data entered in the
User ID
box in the
Data Map Remote Node
dialog box.
Derived from the
User ID
value in the
Data Map Remote Node
dialog box
Binary
Word
LGPWDLEN
The length of the data entered in the
Password
box in the
Data Map Remote Node
dialog box.
Derived from the
Password
value in the
Data Map Remote Node
dialog box
Binary
Word
LGSQLLEN
The length of the data entered in the
SQL Statement
box in the
Database Row Test
dialog box.
Derived from the
SQL Statement
value in the
Database Row Test
dialog box
Binary
Word
LGU1PTR
A pointer to the data stored for String 1.
String 1
value in the
USER Access Method
dialog box
Pointer
Word
LGU2PTR
A pointer to the data stored for String 2.
String 2
value in the
USER Access Method
dialog box
Pointer
Word
LGFNPTR
A pointer to the data stored for File Name.
File Name
value in the
USER Access Method
dialog box
Pointer
Word
LGUIDPTR
A pointer to the data stored for User ID.
User ID
value in the
Data Map Remote Node
dialog box
Pointer
Word
LGPWDPTR
A pointer to the data stored for Password.
Password
value in the
Data Map Remote Node
dialog box
Pointer
Word
LGSQLPTR
A pointer to the data stored for SQL Statement.
SQL Statement
value in the
Database Row Test
dialog box
Pointer
Word
LGPUWK1
A pointer to area of storage for user-defined data.
Set by the user access method program
Binary
Word
LGPUWK2
A pointer to area of storage for user-defined data.
Set by the user access method program
Binary
Word
LGOPENRC
Return code of the OPEN call, as follows :
  • 1. Success.
  • 0. Error.
Set by the user access method program
Binary
Word
LGRECLEN
Length of the retrieved record.
Set by the user access method program
Binary
Word
LGRECPTR
A pointer to the retrieved record data.
Set by the user access method program
Pointer
Word
LGMSGBUF
Message returned to PowerExchange from the user access method program.
Set by the user access method program
Character
80 bytes

0 COMMENTS

We’d like to hear from you!