EDCS II Programmer's Guide

*HyperReader

  CONTENTS

  Title Page

  Copyright Page

  Preface

  New and Changed Features

  1      Processing Commands Through DCL Command Procedures

  1.1     Interactive Versus Batch Mode

  1.2     Running Command Procedures Interactively

  1.3     Running Command Procedures in Batch Mode

  2      Processing Commands Through the Callable Interface

  2.1     Callable Interface Concepts
    2.1.1      Routine Arguments
      2.1.1.1      Argument Passing Mechanisms
      2.1.1.2      Argument Access
      2.1.1.3      Argument Data Types
    2.1.2      EDCS II Constant Files
    2.1.3      Using Unsupported Programming Languages
    2.1.4      Message Handling
    2.1.5      Using the Qualifiers Argument
    2.1.6      Custom Formatting EDCS II SHOW Commands
      2.1.6.1      Step One:  EDCS$SHOW Routine
      2.1.6.2      Step Two: EDCS$GET_SHOW_RECORD Routine
      2.1.6.3      Step Three:  Get Show Item Routines
      2.1.6.4      Step Four:  EDCS$END_SHOW Routine
      2.1.6.5      Custom Formatting the EDCS$SHOW_REVIEW Routine

  2.2     Program Flow

  2.3     Compiling, Linking, and Running a Callable Interface Program

  3      Callable Interface Routine Descriptions

  EDCS$CHECK_LOGIN

  EDCS$CHECK_SYSTEM

  EDCS$CMD

  EDCS$DISP_MSG

  EDCS$END_SHOW

  EDCS$GET_MSG

  EDCS$GET_SHOW_DATE

  EDCS$GET_SHOW_INTEGER

  EDCS$GET_SHOW_RECORD

  EDCS$GET_SHOW_STRING

  EDCS$LOGIN

  EDCS$LOGOUT

  EDCS$SET_ADMINISTRATOR

  EDCS$SET_PASSWORD

  EDCS$SETUP

  EDCS$SHOW_ACCESS_LIST

  EDCS$SHOW_ACCOUNT

  EDCS$SHOW_ATTRIBUTE

  EDCS$SHOW_DATABASE

  EDCS$SHOW_DEPENDENCY

  EDCS$SHOW_ELEMENT

  EDCS$SHOW_GROUP

  EDCS$SHOW_HIERARCHY

  EDCS$SHOW_HISTORY

  EDCS$SHOW_MAILING_LIST

  EDCS$SHOW_PATH

  EDCS$SHOW_PROFILE

  EDCS$SHOW_REQUEST

  EDCS$SHOW_REVIEW

  EDCS$SHOW_SUBSTITUTE

  EDCS$SHOW_TEAM

  EDCS$SHOW_USERS

  EDCS$SHOW_VERSION

  4      Programming Examples for the Callable Interface

  4.1     BASIC Programming Example

  4.2     BLISS Programming Example

  4.3     C Programming Example

  4.4     FORTRAN Programming Example

  4.5     PASCAL Programming Example

  5      Using Query Languages to Query Data Stored in the Database

  5.1     Three Methods of Querying the Data

  5.2     Using a Query Language to Query the Database
    5.2.1      Writing Queries in Uppercase Characters
    5.2.2      Translating Numeric Coded Fields in the Database
    5.2.3      Multiple Records from Queries Involving Attributes
    5.2.4      Using the Output from Queries Within Your Programs
      5.2.4.1      Character String Field Type
      5.2.4.2      Access List Rules
      5.2.4.3      Structure of SAVESET Field in EDCS$ARCHIVE View
    5.2.5      Future View Changes

  5.3     Using RDO to Query the Database

  5.4     Using VAX SQL to Query the Database

  5.5     Using VAX DATATRIEVE to Query the Database

  5.6     EDCS II Predefined Views of the VAX Rdb/VMS Database

  A   Callable Routine Messages

  A.1     Message Format

  A.2     VAX EDCS and Equivalent EDCS II Messages

  A.3     Message Code and Text of All EDCS II Messages

  A.4     EDCS II Callable Interface Messages
    ACTEVERR . . . INVSTRLEN
    ITEMNOTFOUND . . . WRONUMARG

  B   Views of the Database Compatible with VAX EDCS (Version 1.2)

  EXAMPLES

  1-1        FETCH.COM DCL Command Procedure

  1-2        FETCH.COM Rewritten with Parameter Symbols

  1-3        CREATE ACCOUNT DCL Command Procedure

  1-4        DCL Command Procedure for Batch Mode

  1-5        Output from a Command Procedure Run in Batch Mode

  1-6        Batch Mode Command Procedure with Parameter Symbols

  4-1        BASIC Callable Example

  4-2        BLISS Callable Example

  4-3        C Callable Example

  4-4        FORTRAN Callable Example

  4-5        PASCAL Programming Example

  FIGURES

  2-1        Format of Qualifiers Item List

  2-2        Sample Qualifiers Item List

  2-3        Sample Output for EDCS$GET_SHOW_RECORD

  2-4        Buffer Format of SHOW Record

  2-5        Sample Buffer Format of SHOW Record

  2-6        Sample SHOW REVIEW Information for Entity PISTON

  3-1        Format of fao_block Buffer

  TABLES

  2-1        Constant Files in SYS$LIBRARY

  2-2        Get Show Item Routines

  3-1        EDCS II Callable Routines

  3-2        EDCS$SET_ADMINISTRATOR Qualifiers

  3-3        EDCS$SET_PASSWORD Qualifiers

  3-4        EDCS$SHOW_ACCESS_LIST Output

  3-5        Constant Values Returned for EDCS$SHOW_ACCESS_LIST Item Codes

  3-6        EDCS$SHOW_ACCESS_LIST Qualifiers

  3-7        EDCS$SHOW_ACCOUNT Output

  3-8        Constant Values Returned for EDCS$SHOW_ACCOUNT Item Codes

  3-9        EDCS$SHOW_ACCOUNT Qualifiers

  3-10       EDCS$SHOW_ATTRIBUTE Output

  3-11       EDCS$SHOW_ATTRIBUTE Qualifiers

  3-12       EDCS$SHOW_DATABASE Output

  3-13       Constant Values Returned for EDCS$SHOW_DATABASE Item Codes

  3-14       EDCS$SHOW_DATABASE Qualifiers

  3-15       EDCS$SHOW_DEPENDENCY Output

  3-16       EDCS$SHOW_DEPENDENCY Qualifiers

  3-17       EDCS$SHOW_ELEMENT Output

  3-18       Constant Values Returned for EDCS$SHOW_ELEMENT Item Codes

  3-19       EDCS$SHOW_ELEMENT Qualifiers

  3-20       EDCS$SHOW_GROUP Output

  3-21       Constant Values Returned for EDCS$SHOW_GROUP Item Codes

  3-22       EDCS$SHOW_GROUP Qualifiers

  3-23       EDCS$SHOW_HIERARCHY Output

  3-24       EDCS$SHOW_HIERARCHY Qualifiers

  3-25       EDCS$SHOW_HISTORY Output

  3-26       Constant Values Returned for EDCS$SHOW_HISTORY Item Codes

  3-27       EDCS$SHOW_HISTORY Qualifiers

  3-28       EDCS$SHOW_MAILING_LIST Output

  3-29       Constant Values Returned for EDCS$SHOW_MAILING_LIST Item Codes

  3-30       EDCS$SHOW_MAILING_LIST Qualifiers

  3-31       EDCS$SHOW_PATH Output

  3-32       EDCS$SHOW_PATH Qualifiers

  3-33       EDCS$SHOW_PROFILE Output

  3-34       Constant Values Returned for EDCS$SHOW_PROFILE Item Codes

  3-35       EDCS$SHOW_REQUEST Output

  3-36       Constant Values Returned for EDCS$SHOW_REQUEST Item Codes

  3-37       EDCS$SHOW_REQUEST Qualifiers

  3-38       EDCS$SHOW_REVIEW Output

  3-39       Constant Values Returned for EDCS$SHOW_REVIEW Item Codes

  3-40       EDCS$SHOW_REVIEW Qualifiers

  3-41       EDCS$SHOW_SUBSTITUTE Output

  3-42       EDCS$SHOW_SUBSTITUTE Qualifiers

  3-43       EDCS$SHOW_TEAM Output

  3-44       EDCS$SHOW_TEAM Qualifiers

  3-45       EDCS$SHOW_USERS Output

  3-46       EDCS$SHOW_USERS Qualifiers

  3-47       EDCS$SHOW_VERSION Output

  3-48       EDCS$SHOW_VERSION Qualifiers

  4-1        Programming Examples

  5-1        Partial Listing of EDCS II Numeric Coded Fields

  5-2        SAVESET Field in the EDCS$ARCHIVE View

  5-3        EDCS II Views

  A-1        Severity of Messages

  A-2        VAX EDCS and Equivalent EDCS II Messages

  A-3        EDCS II Message Text

  B-1        VAX EDCS and Equivalent EDCS II Views

  B-2        VAX EDCS Views