Index | IBM Version 4 specs

Index

API (application programming

interface)

(continued)

API (application

programming

interface)

(continued)

problem

management

APIs

Set

COBOL

Error

Handler

(QLRSETCE)

use of 8-18

OPM COBOL example B-112

process

open list

APIs

software

product

APIs

use of 8-29

use of 8-20

program

and

CL

command

APIs

types of 1-3

use of 8-19

UNIX-type APIs 2-6

Register

Exit

Point

(QusRegisterExitPoint)

use of 8-21

ILE C example 4-9

use of 8-1

ILE

COBOL

example

B-50

user

interface

APIs

ILE RPG example B-58

use of 8-27

Register

Exit

Point

(QUSRGPT)

user

interface

manager

APIs

OPM

COBOL

example

B-47

use of 8-27

OPM RPG example B-54

versus CL commands 1-3

registration

facility

APIs

virtual

terminal

APIs

use of 8-19

use of 8-28

Remove

Exit

Program

(QusRemoveExitProgram)

work

management

APIs

ILE C example 4-19

use of 8-28

ILE

COBOL

example

B-87

work

station

support

APIs

ILE RPG example B-92

use of 8-28

Remove

Exit

Program

(QUSRMVEP)

Application

Development

Manager

APIs

OPM

COBOL

example

B-85

use of 8-6

OPM RPG example B-90

application

programming

interface

(API)

Report

Software

Error

(QpdReportSoftwareError) Add

Exit

Program

(QUSADDEP)

ILE COBOL example B-122

OPM

COBOL example B-47

required parameter group 3-3

OPM RPG example B-54

Retrieve

Exit

Information

Add

Exit

Program

(QusAddExitProgram)

(QusRetrieveExitInformation)

example

of

keyed

interface 4-3

ILE C example 4-13

ILE C example 4-9

ILE

COBOL

example

B-66

ILE

COBOL

example

B-50

ILE RPG example B-75

ILE RPG example B-58

Retrieve

Exit

Information

(QUSRTVEI)

authorities and locks 3-2

OPM

COBOL

example

B-61

backup

and

recovery

APIs

OPM RPG example B-71

use of 8-1

Retrieve

Job

Description

Information

benefits of using 1-2

(QWDRJOBD)

3-29

categories

1-3

Retrieve

Object

Description (QUSROBJD)

client

support

APIs

ILE C example B-94

use of 8-1

ILE COBOL example B-101

common

information

across

APIs

ILE

RPG

example

B-106

advanced example 4-1

OPM

COBOL

example

B-101

basic example 3-1

OPM RPG example 5-4

communications

APIs

Retrieve Pointer to User Space (QUSPTRUS)

use of 8-2

example

B-66

compatibility with future releases 1-1

ILE C example B-94

configuration

APIs

ILE COBOL example B-101

use of 8-3

ILE

RPG

example

B-106

Create

Product

Definition (QSZCRTPD)

OPM

COBOL

example B-61, B-101

OPM RPG example A-3

OPM RPG example 5-4, B-71

Create

Product

Load

(QSZCRTPL)

Retrieve

User

Space

(QUSRTVUS) 2-13

OPM RPG example A-3

SAA Common Execution Environment (CEE) 2-5

Create Program (QPRCRTPG) 7-5

security

APIs

Create User Space (QUSCRTUS) B-66

use of 8-20

description

2-13

Set COBOL

Error

Handler

example

B-66

(QlnSetCobolErrorHandler)

ILE C example B-94

ILE

COBOL

example

B-122

ILE COBOL example B-101

ILE

RPG

example

B-106

Index X-3

Image 473

IBM Version 4 manual Index

Contents

IBM Page IBM 1997 First Contents Hold ChapterRPG Across APIs ProgrammingMICRTPG2 Cobol OPM Index ViiOPM API Viii System API Programming V4R1 Micrtpg System API Programming V4R1 Disclaimed IBMImplied Warranties of Merchantability and Fitness for Trademarks Programming Interface Information Xiii UsePrerequisite HLL Xiv System API Programming V4R1 Exit programs That are documented Systemin API CompatibilityAPI Compatibility Saved Overhead Processing When You Call Using APIs-BenefitsBecause You Not Have To go Through APIs System APIs or CL Commands-When UseFunctions Cobol ILE RPG Environments Related InformationBesides the OS/400 APIs that are OS/400 APIs Are documented Following books Locating the API to StartedSocket Network Functions This Unix Verb Language Selection Considerations Data Types Selecting the High-Level Language To Use API Environments Environment CEE APIs for the Integrated Language EnvironmentRelated Information APIs for the ILE Common Integrated Language Environment ILE CEE APIs APIs for the Unix EnvironmentAPI Parameters Value of the data object is placed directl Parameter PassingParameter List Langua Parameter Classification Error Code Parameter Error Receiving Error Conditions as Exceptions-ExampleWith Exception Data-Example Code From Errors Getting Started with2-11APIs Security Uses Internal IdentifiersSpooling User Spaces User SpacesSpace Used by Xxxx User Space Format-Example +NO Logic Flow of Processing a List of Entries With Using Offset Values with PointersManipulating a User Synchronizing between Two or More Jobs Position Values Manipulating a User Space without PointersLengths Space APIs Quschgus API Following is a user space after you change it with one \ Program Changusptr Changing a User Space with an ILE RPG Program-Example RPG Changing a User Space with an OPM RPG Program-Example User ListListing Additional Information about Bytes Returned Fields Receiver VariablesBeginning A receiver variable or the beginning of a Qusljob API Keyed Interface User Space Alternative Using a Continuation HandleContinuation Handle Qlicobjd API More information Domain ConceptsAPI Exit Points Security, Qalwusrdmn Set to System configured forsystemC2Exit Programs Library APIs and the Qsysinc Include File CcsidCompile Program Specific User Index Considerations APIs and the Qusrtool LibraryUser Index Considerations InSystthem API Reference, SC41-5801 System Performance ConsiderationsPerformance Considerations 32System API Programming V4R1 Original Program Model OPM API-Scenario InformationJob Held Queue First Step Finding the correct API is to Identify Part That Parameters Description of an APILocks Authorities Performs Object For Are Based Objects ThatAre described in Required Parameter Group Format You Can See fromDecthedecimal Offset Column Would Make Binary Value Because the field is a binaryCan Place Format Name Pass Literal This Name Format Error MessagesField Descriptions Optional Parameter Group Hold Parameter ExamplePerspective Only Possible values For Hold Job Queue Field Are APIs-Examples Call Jobdapi Parmqbatch Qgpl Handling Error Conditions-OPM RPG ExampleCall Jobdapi Parmqbatch \LIBL Call Jobdapi Parmxyz \LIBL OPM RPG Ipgmsts SDS Msgidd ITOUSRQPGMR36 47 MSG3B Parameter Error Error Code Structure Can Found Format Error code structure Qusbn is Common Information across APIs-Basic OPM 3-Example13 Qgpl Call Jobdapi Qpgmr XYZ XYZLibrary Does Not Exist. Use the following call statement Level Date Pgmr Change Description Value Placed Code used to access the Hold attribute. T Accessing the Hold Attribute-OPMDiagnostic Message exists Job Log Can Received Following data structures are used Error-code data structureRetrieve job description data structure Structure Information across APIs-Basic OPM 3-Example Initial \$Að= D2862ððð Common Information across APIs-Basic OPM 3-Example21 Icmdstr \ENTRY Jobdapi With ListSpooled Ispcnam Outq Common Information across APIs-Basic OPM 3-Example27 Qusptrus Qusrtvus Processing API-ExampleJob Description Information Parameters JOBD0100 Format CHAR8 End Severity BytesBytes Returned Job date ReplyJob Library MSG YES Offset RQD DataText Description Common Information across APIs-Basic OPM 3-Example37 38System API Programming V4R1 ILE API AcrossIntegrated Language Environment Point APIs-ConceptsGeneric Header Files Exit Program Attributes Parameter Keyed Interface-ExampleVariable-Length Structure-Example Key Type Field Exit Program Attribute Keys Error Handling through the Error Code Parameter Error HandlingCcsid Initialize Bytes provided Field Number Parameter Exception handling is by having All Exceptions Signa Second Entry Receiver Variables-Examples Fields-Example With ILE C Registration Facility Using ILE APIs-ExamplesAdd Exit Program-ILE \EXCLUDE Description Exit Point Example API 12System API Programming V4R1 Language ILE C EXAMPLEPGMEXAMPLELIB, Example Exit Program DataProgram Output None Rslvsppgmhdlr FunctionInput Information retrieved 16System API Programming V4R1 Common Information across APIs-Advanced ILE4-17Example 18System API Programming V4R1 Language ILE C Description Remove Exit Program and Deregister Exit Point-ILE C Example 20System API Programming V4R1 Errorcode.ecfields.ExceptionId Exit1 \ End program \ 22System API Programming V4R1 General Data Structure Characteristics of a List General Data Structure Offset to List Data Section On page 5-14 and the OBJP0200 Format on 5-14. This Other Fields of Generic HeaderQsylobjp API Can Locate Remaining Information Place See Add Size Each Entry Field Get .7/ starton Processing a ListList Object API-OPM RPG Example Iqusbn \/COPY QSYSINC/QRPGSRC,QUSEC\FLAG Reason Level Date Pgmr Change Description Qusbng QusbnfIqusky Quskyf Exsr Init Exsr Proces Exsr Done \ENTRY Plist ParmBegsr Call Qsylobjp Parm Spcnam Parm RjobdfParm Spctyp Qusbnc PROC2 ADD Qusbpq StrposSizent QSYB6 Qusbpj Ifeq Nument Exsr PROC2ADD Qusbpl Strpos Movelqusrtvusapinam Exsr Apierr Endif Begsr Movelqusbpj Lststs Endif USRSPC=P/C EndsrDoueqc Oreq Exsr PROC1 Required Parameter Group Authorities and Locks OBJP0200 OBJP0100User name Object type Section User Space Variables Attribute Field DescriptionsInput User Continuation handle not valid for Service Program Library &2 ended. Reason codObject Type Not Valid User space &4 in &9 damaged OPM Error ConditionsParameters Pointers This Program Calls Log Software Error QpdlogerFfdc Without Pointers-ILE Output None Exceptions Ffdc Input Unexpectedhdlr Function \HANDLE 6System API Programming V4R1 API with Pointers-ILE C Example Software Error ILE\ Unexpectedhdlr \ QCLE/H Function SymptommsgkeywordMSGSYMPTOMLEN \HANDLE Numberofkeys, &ErrorCode 12System API Programming V4R1 Machine InterfaceInterface Instructions-Introduction Setting the Declare Statements Setting the Entry PointWriting an MI Program-Example Section Discussing ARG2 ITS2Cpynv Result MI01 Program-Complete Code Example Compiling a Program Rexx Using Clcrtpg to Create Creating the MI Example Program Testing MI01 Debugging the MI Program ProgramSAV RST BRK Are Compilers HLLs. BreakDirective allows users Language Statement Such Handling Exceptions in the MI Program Following is an updated view of the MI01 program String 1202 Where 0C12 =andX 02 02= .X While mostExcid Hexadecimal representation of the message id Creating an MI Version of Clcrtpg Program Flow for Creating the Micrtpg Program Qprcrtpg .API Source for CL04 follows Source for CL03 follows Source for CL05 follows Source for Micrtpg follows Source for the Micrtpg Program Declaring the Structure CodeUnderstanding the Micrtpg Program by Following, however, are new statements Usrspc Declaring PointersUsrspcobj Creating the Micrtpg Program Understanding the MICRTPG2 Program by Sections of CodeCalling Enhanced Version Instruction stream, create the space Establish addressability to the Crts template Qcmdexc API BinoffsetOvrdbf DCL Spcptr CLOVRLNG@ Initclovrlng DCL DD Cldltcmd CHAR12 Initdltovr MisrcDCL Spcptr CLDLTLNG@ Initcldltlng CLOVRLNG@ ARG Storage Beginning the Instruction StreamTo Your Advantage Delete the previous Ovrdbf MICRTPG2 Complete Program-MI Code ExampleCall the Qprcrtpg API to create the MI program Indicate that the program is done DCL Spcptr Usrspc DCL Sysptr USRSPC@ DCL DD Numparms BIN DCL Spcptr PGMOPTS@ Initpgmopts DCL DD Numopts BIN4 INIT3 DCL Sysptr QTEMP@ BaspcoCrts MI Following is the updated CL06 program Updated CL06 ProgramPGM PARM&BUFFER &OFFSET Dclf Filemisrc DCL DCL VAR&OFFSET TYPE\DEC LEN15 Loop Rcvf Qtemp Creating the MICRTPG2Handling Exceptions Its Consolidated State This Is the new MICRTPG2 program Example Machine Interface Programming7-29 CTXQSYS, Typepgm Retexcpd INT Entry \ EXT MI Common Programming Techniques-ExamplesDCL Spcptr SEPT@ Defpco DCL Sysptr QTEMP@ Defpco POS DCL DD Matctxopts CHAR44 DCL DD MatctxctlDCL DD Sreceiver CHAR8 BDRY16 DCL DD Sbytprv DCL DD Sbytavl Deflreceiver DCL DD LextattrDCL DD Lentry DCL DD Objentry Cmpnvb SBYTAVL, 96 / Eqdone SRECEIVER@, QTEMP@, MatctxoptsLRECEIVER@, Sbytavl Cpynv LBYTPRV, Sbytavl API before Developing Your Cations AS/400 Program StorageProcess Allo Cating Initializing automatic Storage APIs Backup Recovery Provides Way to That Is only provided Service ProgramCommunications APIs Returns a list of configuration descriptions, based on a Configuration APIsDebugger APIs OptiConnect APIs Window services Low-level servicesDynamic Screen Manager APIs Debugger Edit Function APIs Session servicesFile APIs An edit Code Qdls Hierarchical File SystemHardware Resource APIs ILE CEE APIs Cobol APIs Message Handling APIs Journal and Commit APIsJournal APIs Commitment Control APIs Network Management APIs National Language Support APIsNational Language Support APIs Data Alert APIs SNA/Management Services Transport SNA/MS Transport APIs Node List API Object APIsFilter Change Request Management APIs Following describes Clear Data Queue Qclrdtaq Retrieve DescriptionLifo Usridx User Index APIs8APIs-13 Chglibl Object APIs Movobj Office APIsAllows you to rename and mov Conversion Exit Programs Which Are Discussed Under Office MSF File Server APIsOffice Exit Programs Print APIs Performance Collector APIsPrint APIs Most Functions Filtering Problem Management APIs Working with a Problem Program and CL Command APIsProblem Log Entry APIs Error Reporting APIs Software Product APIs Security APIs Getenv UNIX-Type APIsEnvironment Variable APIs Interprocess Communication APIs Integrated File System APIsHas Exec Function Queues An X/Open Specification As a mechanism by which a process Signal APIsSemaphore Are identifie Action Signal MIB IDa Server Client Sockets APIs Process-Related APIs User Interface APIsUIM Advantages UIM Work DDS AdvantagesWork Management APIs Support Miscellaneous APIs Miscellaneous APIsList APIs Process Find Field Numbers List Qgyoljbl API That show you how to avoid Errors Programming errors and refers you toUsing the error code Task Incorrect Using the Error Code ParameterXxxxxxx Is shown at .2/locationinthe incorrect and correct coding Call Quscrtus Parm Spcnam Using the Error Code Parameter-Example of Correct CodingParm SIZ Intval Parm \ALL Csetonlr Parm Extattrextatr 1ð Incorrect Coding Defining Data StructuresLength is Defined Through Length Through This Jobnbr \ SET UP to Accept Exceptions ADD\ZEROSJobid Jstat Defining a Data Structure-Example Coding \ Create the Space to Hold the Data Call Quscrtus Intval \ SET UP to Accept Exceptions ADD\ZEROS\ Call the API to List the Active Jobs Qusljob List Entry from the Space \ Delete the Space That Held the Data When Run Lists All Active Jobs System When Defining Receiver VariablesMay Written Over with These extra characters. On Call RPG Qusbn \ Retrieve the Offset Qusbn \ Call the API to List the Active Jobs QusljobADD1 Start Qusbn \ Retrieve the List Entries Qusbpq ADD Start \\ JOB Name Structure for Calling Qusljob Ijobnam \ALL Qusgen Qusbn \ Retrieve List Entries Qusbpq ADD Start \\ Data Structure Containing Space NAME/LIB Ispcnam DS DefiningIncorrect ADD1 Dowlequsbps Qusbn \ Call the API to List the Active Jobs Movelqusdd Recvr CodingRecvr ADD Start END \ Delete the Space That Held the Data Format Lengths-Example Correct ADD\ZEROS ILE NullNull Using Null Pointers with OPM APIs-Example of Correct Coding 20System API Programming V4R1 \CURLIB Correct Byte Alignment ensures that data used With an Byte QusVlenRec4t descrec Char Desc5ð Addepattributes This is a Test Exit PROGRAM,27 ILE C Defining Byte Alignment-Example Correct EXAMPLEPGMEXAMPLELIB, Example Exit Program Data Using Offsets in a User Using Offsets in a User SpaceIncorrect Point For Beginning Read User \FLAG Reason Level Date Pgmr Iusersp APIUG1 Copy QSYSINC/QRPGSRC,QUSLOBJQgpl Iobject \ALL Qusbps Qusbpj Ifeq C Oreq PADD1 Count Addqusbpq Strpos Lendta User Space-Example Using Offsets in aCorrect Coding \FLAG Reason Level Date Pgmr Call Quscrtus Parm Iusersp APIUG1 Usrspc Qgpl SpclibIobject \ALL Objnam Qgpl Objlib Qusbpq ADD Strpos Oreq Exsr Errcod Seton Retrn For Coding for New Function \FLAG Reason Dspcname Inzadopts Qtemp DspcsizeDspcinit Qussgh QusuaQussrl Qusfn Pgmr Change Description QSYDqsyobjph Basedlstptr QSYOBJT12 Move Qusis Proces BegsrLststatus Doueq Qusis Ifeq Oreq Eval Lstptr = %ADDRARRQUSOIP + Qusis IfeqEND Else Exsr Done END Call Qusrobjd Parm Rcvvar Rcvvarsiz Eval Qusbprv = %SIZEQUSECRobjdfmt Parm Spcname \USRSPC Objtype Qusec Qusei Ifeq PGM, or Coding for New Function-Example CorrectDoes Not match 9B ð INZ1 Basedspcptr Lupa 46System API Programming V4R1 Dsply Else Else QSYOBJT12 Ifeq Eval Lstptr = Addrarrqussee + END QSYOBJT12 Ifeq \SRVPGMEval Lstptr = Addrarrqusoip + Ifeq \BLANKS Move Mbrlist Parm \CURRENT Usrprf Call Qsylobjp Parm SpcnameObjtype Parm Parm Qusec Parm \USER Spcdomain RPG Example on page A-3 Packaging Your Own Software ProductsSoftware products Object Description Packaging aCL Program for Dltlib ABC Crtpf ABC/ABCPF ABCDEV/QDDSSRC + Crtdspf ABC/ABCDSPF ABCDEV/QDDSSRC +Crtcmd ABC/ABC ABC/ABCPGM ABCDEV/QCMDSRC + Crtpnlgrp ABC/ABCPNLGRP ABCDEV/QPNLSRC + Copy QSYSINC/QRPGSRC,QSZCRTPD Copy QSYSINC/QRPGSRC,QSZPKGPO Copy QSYSINC/QRPGSRC,QSZCRTPLTextd Phone Exsr Pkgpo Exsr CobjdPrddfn Begsr Qszbcb Parm Qszbc MovelqszcrtpdapiParm Qszbd Parm Qszbf Qszbh Movelqszcrtplapi Call QszcrtplQszbj Qszbk Move OBJ,I Objds Name CAT ABC CobjdCobji Pkgpo Movelqszpkgpoapi Call Qszpkgpo Parm Qszbr MOVEL\ALL QszbrfParm \YES Repkg Parm \NO Retriev Command B-129Qszrtvpr API Rtvfd \CHANGE \INT \LCL Queue entries are manipulated. F Using Data Queues versusUser Data Queue-ILE C Example Example User Queue-ILE C ExampleQueuelib 18System API Programming V4R1 Valid \USER Appendix A. Performing Tasks Using APIs-ExamplesA-21 22System API Programming V4R1 Additional Languages Appendix Hold Parameter Exception Message-ILE C Original Program Model OPM APIs-ExamplesExample on For the original Jobdapi Appendix Original Examples in Additional Identification Division Message-ILE Cobol Cobol Procedure Division Using JOBD, JOBDL. .8/ MAIN-LINEPROGRAM-ID. Jobdapi Environment Division Copy Qusec of QSYSINC-QLBLSRC Copy QSYSINC/QRPGLESRC,QUSEC Move Jobd to JOB-DESC. Move Jobdl to JOB-DESC-LIBMove HOLD-JOB-QUEUE to Hold INZ Tousrqpgmr DcmdstringDrcvlen Dformat Handling Error Error Begsr Exsr ErrorJobd CAT Jobdlib Lfnam Call Qwdrjobd Jobdapi Appendix B. Original Examples in Additional BLanguages-11 Identification Division Perform Errcod Procedure Division Using JOBD, JOBDL. MAIN-LINEMove 16 to BYTES-PROVIDED Copy QSYSINC/QRPGLESRC,QWDRJOBD Call Qcmdexc Using MESSAGE-TWO, COMMAND-LENGTH, Stop RUN Msgid INZ Tousrqpgmr DCMDSTR2Dlenstr INZ%SIZECMDSTRING DLENSTR2 INZ%SIZECMDSTR2 Call Qwdrjobd Parm Parm LENSTR2 Endsr Accessing the Hold Attribute-ILE C ExampleMovel Qusei Msgid Call Qcmdexc Parm File PROGRAM-ID. Jobdapi Hold Attribute-ILE Label Records are Standard Data Division File SectionData Record is LIST-LINE LIST-LINE BAD Open Output Listing Move EXCEPTION-ID to Msgid Attribute-OPM RPG Example On page 3-17 f Original Refer To Accessing Except BAD END Except Good ElseOqprint Good Oqprint BAD Appendix B. Original Examples in Additional 24System API Programming V4R1 For Original example. The following program also Refer Accessing Field Value Initial Library List-OPMList-ILE Cobol Example Value Qwdrjobd Roch DEVICE-RECOVERY-ACTION PIC JOB-SWITCHES PICBYTES-RETURNED BYTES-AVAILABLE Perform NUMBER-LIBS-IN-LIB-LIST Times Call Qcmdexc Using COMMAND-STRING, COMMAND-LENGTH, ADD 11 to Reclen List-ILE RPG Qwdbavl Qwdbrtn Qwdjdln QwdjdnQwdun Qwdjd Qwdlrd QwdordQwdjmqms Qwdjmqfa Exsr Error Else Using Keys with ListQwdoill ADD Qwdnlill Eval Call Qcmdexc Parm Cmdstring Lenstr ADD Quslspl Appendix B. Original Examples in Additional BLanguages-35 36System API Programming V4R1 Appendix B. Original Examples in Additional BLanguages-37 Prtfil PIC Using Keys with List Spooled Files API-ILE Cobol ExampleFiller PIC Pages Lsterr TEXT1 PIC Opndat PICHdrerr TEXT2 PIC Misc SPC-NAME PIC KEY-INFO Procedure DIVISION. MAIN-LINECall Qusptrus Using SPC-NAME, SPCPTR, QUS-EC STRING-SPACE Spcptr SET SETSTRING-SPACEOFFSET-LIST-DATA Perform Proces To Opndat Using Keys with List Spooled Files API-ILE RPG ExampleInzspcname Qtemp Dspcsize Dlstptr DLSTPTR2 Dspcptr Appendix B. Original Examples in Additional BLanguages-43 BASEDLSTPTR2 Dqussplki\QUSERVED34 \ QUSERVED35 Parm Qusec \USER Parm \BLANKS SpctextCall Quslspl Parm Spcname Format Parm \CURRENT Usrprf Eval LSTPTR2 = %ADDRARRX END Except Prtlin AGE CAS Error ENDFilnam Begsr Move \BLANKS Prtfil Eval Exit APIs-ExamplesCobol Example Integrated EXCEPTION-ID PIC BAD-REG TEXT1 PICBAD-ADD TEXT1 PIC VAR-OFFSET Move 3 to CONTROL-KEY of QUS-VLEN-REC-4 Move 2 to NBR-RECORDSMove Exit Point Example Move 4 to CONTROL-KEY of QUS-VLEN-REC-4 Register Exit Point By Content Length of EXIT-PGM-DATA of MISC, VARREC, QUS-EC TEXT1 PIC X1ððð Ð1 Misc EXIT-POINT-NAME of MISC, FORMAT-NAME of MISC, VARREC, QUS-EC RPG Copy QSYSINC/QRPGSRC,QUS I\ Printer \ Compile Time Array RECIvarrec Iovrlay ADD3 ADD2ADD4 Binary ADD Moveabinc REC,OF Exsr Calcvo ADD8 ADD37 Binary Moveabinc REC,OF Exsr REC,OF ExsrCall Qusaddep Qusbnc Ifgt Open Errpgm ErreptPrinter OFLIND\INOF Usropn Copy QSYSINC/QRPGLESRC,QUS Recs Dvarrec NbrrecsDvoffset Doverlays Binary Parm Epntname CallbFormat Parm Varrec Qusec Open Qprint Except Erraepnt Exsr Done Endif Information-OPM Cobol EXCEPTION-ID PROGRAM-ID. REGFAC2 Environment DivisionBAD-CREATE TEXT1 Misc EXIT-POINT-NAME PIC FORMAT-NAME-2 PIC FORMAT-NAME-1 PICBASE-POINTER Pointer INFO-POINTER SPACE-NAME PIC Value Rcvvar Qtemp SPACE-ATTR PIC Move Spaces to CONTINUATION-HDL Call Qusptrus Using SPACE-NAME, BASE-POINTER, QUS-EC Perform CALL-EXIT-PROGRAMS Else Stop RUNTo CONTINUATION-HDL CALL-EXIT-PROGRAMS To Address of RCVVAROFFSET-PROGRAM-ENTRY Write LIST-LINE from BAD-EXIT-PGM, Stop RUNPerform CALL-PGMS CALL-PGMS Value -1 Binary Value ExampleexitpointEXIT-PGM-NBR 68System API Programming V4R1 Appendix B. Original Examples in Additional BLanguages-69 Open Output Listing Move EXCEPTION-ID of QUS-EC Appendix B. Original Examples in Additional BLanguages Ircv Copy QSYSINC/QRPGSRC,QUSREGMove \BLANKS Call Qusrtvei Parm Conthd RCV Rcvsz Parm Epgmnb Parm EpntnmQusccb SUBSTRCV1 Quscj Parm RCV RcvszADD Quscjf Substrcvy Quscjg Done Begsr Seton Retrn Endsr Oqprint Information-ILE RPG ExampleQusbnd Oqprint \ Based Qusppn DquspeQuspplib Qusppf Qusmi QusmlibDqusse Qusco Qusnbrep QusmepQusad Qusacc Qusce QusoneQuspgmn Quspgml \QUSPD QusledQusopgme Quslpgme Qusmfill QUSFN12Qusopd Quslpd \ QUSERVED11 \ QUSFN13Qusrei Depntname Inzexampleexitpoint Depgmnbr Callb Qusrei Parm Continhdl Rcvvar Rcvvarsz Move \BLANKS ContinhdlFormat Parm Epntname Epntfmt Parm Epgmnbr Qusnbrsc Qusec Cusrei Begsr DOWExsr Cusrei Enddo Endif Done Parm Exitparms Remove Exit ProgramEval Infspcptr = %ADDRRCVVARQUSONE+1 Enddo Endsr Begsr Eval PGM-NBR Call Qusdrgpt Using EXIT-POINT-NAME, FORMAT-NAME, QUS-EC PROGRAM-ID. REGFAC3 Environment Division EXIT-POINT-NAME, FORMAT-NAME, QUS-EC Exampleexitpoint Epntnm Call Qusdrgpt Parm Pgmnbr Qusbn Dpgmnbr Qusrepgm Callb Qusdep Parm Epntname Callb Qusrepgm Parm EpntnameFormat Parm Pgmnbr Qusec Object API-ILE C Appendix B. Original Examples in Additional BLanguages-95 96System API Programming V4R1 Appendix B. Original Examples in Additional BLanguages-97 98System API Programming V4R1 Appendix B. Original Examples in Additional BLanguages-99 100 INPUT-OUTPUT Section List Object API-ILE Cobol ExamplePROGRAM-ID. Listadopt Environment Division 102 OBJ-TYPE PIC Procedure Division Using USR-PRF, OBJ-TYPE. MAIN-LINECopy Qsylobjp of QSYSINC-QLBLSRC Address of STRING-SPACE Perform DONE, END-IF PROCES2 Perform PROCES2To LST-STATUS, END-IF END-IF, END-IF Else Move Length of QUS-EC to BYTES-PROVIDED of QUS-EC Move Qsylobjp to APINAM, Perform ApierrMove Quscrtus to APINAM, Perform Apierr Move Qusrobjd to APINAM, Perform Apierr Move Qusptrus to APINAM, Perform Apierr 106Display Apinam Display EXCEPTION-ID of QUS-EC. Perform Done Write LIST-LINE from END-LIST. Stop RUN Dlstptr Dspcptr Darr Basedlstptr DIM32767 Drcvvar Inzadopts Qtemp Dspcsize QSYOBJT13 108QSYOBJA11 QSYOBJT14 Lststatus Qusnbrle Except ObjentryEval Lstptr = %ADDRARRQUSSEE + 1 END Robjdfmt Parm Spcname \USRSPC Spctype Qusec Exsr Getlst Move Qusis Lststatus END ElseMbrlist Parm Usrprf Objtype Continhdl Qusec CPF98ð1 CBLERR1 Program Pointers-ExamplesWithout Logging ERRHDL1 \LIBL Scope PIC ERROR-HANDLER PICPROGRAM-ID. CBLERR1 ERRHDL1 Program PRIOR-ERROR-HANDLER of MISC, QUS-ECADD X to Y PROGRAM-ID. ERRHDL1 MESSAGE-KEY PIC Misc LOG-EXCEPTION-ID PICPOINT-OF-FAILURE PIC Binary Value PRINT-JOBLOG PIC Move 1 to MSG-OFFSET Logging Software Error OPMLIBRARY-NAME Move C to SYS-OPTION. Stop RUN Ipsds SRC TGTExcpid Imisc FACT1 SwitchFACT2 FACT1 DIV FACT2 Result API without Pointers-ILE C Example Logging Software Error OPM API without Pointers-ILE Dpsds SDS 120 Appendix B. Original Examples in Additional BLanguages-121 Refer to Reporting Software Error ILE This section includes the examples Reporting Software ErrorCBLERR2 Program Reporting NUMERIC-GROUP PIC ERROR-HANDLERCopy Qusec of QSYSINC-QCBLLESRC Copy Qpdsrvpg of QSYSINC-QCBLLESRC ERRHDL2 ProgramPROGRAM-ID. ERRHDL2 MESSAGE-LENGTH Procedure Division Using CBL-EXCEPTION-IDSYS-OPTION PIC CBL-PGM-NAME Software RPG Example126 Dpsds Copy QSYSINC/QRPGLESRC,QPDSRVPG D\Inzrc 128System API Programming V4R1 Sftwprdex This Section Includes the examples Packaging YourSoftware Produ 130System API Programming V4R1 Object ABCðð29 MRI object For Product 132System API Programming V4R1 ABCPGMMRI1ABC ABCPGMMRM2ABCABCPGMMRI2ABC Qclsrc ABC 134 Appendix B. Original Examples in Additional BLanguages-135 Qszcrtpd Program for Packaging a Product-ILE Cobol ExampleQszpkgpo PROGRAM-ID. Sftwprdex Environment Division Copy Qszcrtpl of QSYSINC-QLBLSRC Copy Qszcrtpd of QSYSINC-QLBLSRCCopy Qszpkgpo of QSYSINC-QLBLSRC API-NAME PIC KEY13 NumkeyLEN13 PID13 PIC Perform Cobjd Perform PrdlodPerform Pkgpo Prddfn Move Spaces to Reserved of QSZ-LNG-LOD Call Qszcrtpd Using PROD-NAME, QSZ-PRD-INF, QSZ-PRD-OPTMove Qszcrtpd to API-NAME, Perform Errcod Prdlod Move ABCPGMMRI1 to PRE-EXT-PGM of QSZ-PRE-EXT Move Qszcrtpl to API-NAME, Perform ErrcodMove ABCPGMMRI2 to POST-EXIT-PGM of QSZ-LIB-INF Move Qlicobjd to API-NAME, Perform Errcod Open Output LISTING, Move 1 to FIRST-ERR Call Qszpkgpo Using QSZ-PRD-OPT-INF, REPKG, ALWCHG, QUS-ECMove Qszpkgpo to API-NAME, Perform Errcod Packaging a 144Refer To Program For Product-OPM RPG Example on page A-3 fo Original PID13 KEY12 Dcobji NumkeyLID12 KEY5 Dapiname Dfirsterr Eval Qszamr = \NO Qszridt = \PHONE 146Eval Qszadn = \NODYNNAM Parm Prodname Qszpi Qszpo Parm Pubaut Qusec Parm QszllExsr Errcod Endif Endsr Eval Qszlt = \CODE Qszlid = \CODEDFT 148 Cobjd Begsr Parm QszalParm Qszpe Nbrpe Qszfl 150 Endsr Oqprint Badnews Open Qprint Eval Firsterr = EndifApiname Qusei \\CTDATA Objinfo Space-ILE Cobol Example Space-ExamplesFILE-USED PIC SPACE-INIT PIC System PIC Overrides PICFORMAT-1 PIC EXT-ATTR PIC API-ERROR-FOUND Call Qusptrus Using SPACE-NAME, SPACE-POINTER, QUS-ECSET Address of QDB-QDBFH to SPACE-POINTER Display API-NAME To a User Space-ILE RPG Example 156 Qdbfhmxm Qdbfhupl\NOMAX Qdbfwtfi Frcratio QdbfhfrtQdbhmnum QDBRSV11 \QDBQAAF2 QDBBITS31 QdbfvrmQDBRSV17 Qdbfhcrt 160 Qdbffigl QDBRSV23Qdbfmxrl QDBRSV24 Qdbfhrls Fcfo Fifo LifoQDBRSV27 Qdbpfof Dspcname Dfilename Dfmtname Dfileused Dlibname Dspcsize QDBRSV28Dspcptr Dformat Doverrides Dsystem INZ\LCL DFORMAT1 INZ\INT Dchgattr Nbrattr Spcsize Parm Spcinit \CHANGE Spcaut Qdbrtvfd Spctext Call Quscrtus Parm Spcname \BLANKS ExtattrCall Quscusat Parm Libname Spcname Chgattr Qusec Qusbavl Ifgt Movel Quscusat Apinam Exsr Apierr END Data Queue-ILE Cobol Example Data Queue-Examples PROGRAM-ID. Dqueuex Environment Division FIRST-ERROR PICCopy Qcapcmd of QSYSINC-QLBLSRC Crtlib MSG-BACK PIC WAIT-TIMEMSG PIC Display MSG-BACK ERROR-FOUNDMove 1 to FIRST-ERROR Data Queue-OPM RPG Example 170 Moveldltlib Cmdstr Exsr ExccmdExsr Exccmd Seton Retrn Qcabc 172 Data Eval Cmdstr = Crtlib Lenstr = %SIZECRTLIB Exsr Execcmd Eval Qcamk = \BLANKS Qcaerved = \LOVALEval Cmdstr = Crtdq Lenstr = %SIZECRTDQ Exsr Execcmd Parm Exampleq 174 Theread UNIX-Type APIs-Examples 176System API Programming V4R1 Appendix B. Original Examples in Additional BLanguages-177 Using the Integrated File System-ILE Cobol Example PRT-TEXT PIC PROGRAM-ID. IFS Environment DivisionUser PIC Curdir PRT-TEXT PIC Testfile Procedure DIVISION. MAIN-LINE Open Output ListingValue LOW-VALUE Oflag PIC To LIST-LINE Write LIST-LINE Perform ERROR-FOUNDGiving RETURN-INT If RETURN-INT Write LIST-LINE. Stop RUN To LIST-LINE Perform ERROR-FOUNDTo LIST-LINE Perform ERROR-FOUND Else Fqsysprt ERROR-FOUND Write LIST-LINE 184System API Programming V4R1 BLanguages-185 186 Appendix B. Original Examples in Additional BLanguages-187 Oqsysprt Books Bibliography Books Bibliography H-3 4System API Programming V4R1 Index Numerics API application programming interface Index ILE RPG Index Chgenvvar CEE Dspjobd Display Example Qusrtvei API Exception Type EXT ILE IPC Listing Message key Management APIs Assistant Exit Program OptiConnect APIs PL/I PL/I API Retrieve Qlpcdinf Generate CD-ROM Premastering Infor- mation API Qusdrgpt Deregister Exit Point API Qearmvbm API SAA Controls MI instruction Station Page Please tell us how we can improve this manual How satisfiedTo return this form Other countries+1+507+253-5192 SC41-5800-00 Reader Comments-Wed Like to Hear from YouPage IBM IBM