Ibm | IBM Version 4 specs

AS/400 Advanced Series

System API Programming

Version 4

IBM

SC41-5800-00

Image 3

IBM Version 4 manual Ibm

Contents

IBM Page IBM 1997 First Contents Across ChapterHold RPG Programming MICRTPG2APIs Cobol OPM Vii OPM APIIndex Viii System API Programming V4R1 Micrtpg System API Programming V4R1 IBM Implied Warranties of Merchantability and Fitness forDisclaimed Trademarks Programming Interface Information HLL UseXiii Prerequisite Xiv System API Programming V4R1 API Compatibility API CompatibilityExit programs That are documented Systemin You Not Have To go Through Using APIs-BenefitsSaved Overhead Processing When You Call Because Cobol ILE RPG System APIs or CL Commands-When UseAPIs Functions OS/400 APIs Are documented Following books Related InformationEnvironments Besides the OS/400 APIs that are Unix StartedLocating the API to Socket Network Functions This Verb Language Selection Considerations Data Types Selecting the High-Level Language To Use API Environments APIs for the ILE Common APIs for the Integrated Language EnvironmentEnvironment CEE Related Information APIs for the Unix Environment API ParametersIntegrated Language Environment ILE CEE APIs Langua Parameter PassingValue of the data object is placed directl Parameter List Parameter Classification Error Code Parameter Code Receiving Error Conditions as Exceptions-ExampleError With Exception Data-Example From Errors Getting Started with2-11APIs Internal Identifiers SpoolingSecurity Uses Used by User SpacesUser Spaces Space Xxxx User Space Format-Example +NO Logic Flow of Processing a List of Entries Synchronizing between Two or More Jobs Using Offset Values with PointersWith Manipulating a User Space APIs Manipulating a User Space without PointersPosition Values Lengths 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 Additional Information about ListUser Listing A receiver variable or the beginning of a Receiver VariablesBytes Returned Fields Beginning Qusljob API Keyed Interface Qlicobjd API Using a Continuation HandleUser Space Alternative Continuation Handle Domain Concepts APIMore information Security, Qalwusrdmn Set to System configured forsystemC2 Exit ProgramsExit Points Library APIs and the Qsysinc Ccsid Compile Program SpecificInclude File InSystthem API Reference, SC41-5801 APIs and the Qusrtool LibraryUser Index Considerations User Index Considerations Performance Considerations Performance ConsiderationsSystem 32System API Programming V4R1 First Step Finding the correct API is to Identify Part That InformationOriginal Program Model OPM API-Scenario Job Held Queue Authorities Description of an APIParameters Locks Format You Can See fromDecthedecimal Offset Column Are Based Objects ThatPerforms Object For Are described in Required Parameter Group This Name Because the field is a binaryWould Make Binary Value Can Place Format Name Pass Literal Optional Parameter Group Error MessagesFormat Field Descriptions Only Possible values For Hold Job Queue Field Are ExampleHold Parameter Perspective APIs-Examples Call Jobdapi Parmxyz \LIBL Handling Error Conditions-OPM RPG ExampleCall Jobdapi Parmqbatch Qgpl Call Jobdapi Parmqbatch \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 XYZ Library Does Not Exist. Use the following call statementCall Jobdapi Qpgmr XYZ Level Date Pgmr Change Description Value Placed Accessing the Hold Attribute-OPM Diagnostic Message exists Job Log Can ReceivedCode used to access the Hold attribute. T Structure Error-code data structureFollowing data structures are used Retrieve job description data structure Information across APIs-Basic OPM 3-Example Initial \$Að= D2862ððð Common Information across APIs-Basic OPM 3-Example21 Icmdstr \ENTRY With List SpooledJobdapi Ispcnam Outq Common Information across APIs-Basic OPM 3-Example27 Qusptrus Qusrtvus Parameters API-ExampleProcessing Job Description Information JOBD0100 Format CHAR8 Bytes Bytes ReturnedEnd Severity Library ReplyJob date Job MSG YES Offset Data Text DescriptionRQD Common Information across APIs-Basic OPM 3-Example37 38System API Programming V4R1 Across Integrated Language EnvironmentILE API APIs-Concepts Generic Header FilesPoint Keyed Interface-Example Variable-Length Structure-ExampleExit Program Attributes Parameter Key Type Field Exit Program Attribute Keys Initialize Bytes provided Field Number Parameter Error HandlingError Handling through the Error Code Parameter Ccsid Exception handling is by having All Exceptions Signa Second Entry Receiver Variables-Examples Fields-Example With Registration Facility Using ILE APIs-Examples Add Exit Program-ILEILE C \EXCLUDE Description Exit Point Example API 12System API Programming V4R1 EXAMPLEPGMEXAMPLELIB, Example Exit Program Data ProgramLanguage ILE C Rslvsppgmhdlr Function InputOutput None 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 Can Locate Remaining Information Place Other Fields of Generic HeaderOn page 5-14 and the OBJP0200 Format on 5-14. This Qsylobjp API Processing a List List Object API-OPM RPG ExampleSee Add Size Each Entry Field Get .7/ starton \/COPY QSYSINC/QRPGSRC,QUSEC \FLAG Reason Level Date Pgmr Change DescriptionIqusbn Quskyf QusbnfQusbng Iqusky Call Qsylobjp \ENTRY Plist ParmExsr Init Exsr Proces Exsr Done Begsr Qusbnc Parm RjobdfParm Spcnam Parm Spctyp QSYB6 ADD Qusbpq StrposPROC2 Sizent Movelqusrtvusapinam Exsr Apierr Endif Nument Exsr PROC2Qusbpj Ifeq ADD Qusbpl Strpos Oreq Exsr PROC1 Endif USRSPC=P/C EndsrBegsr Movelqusbpj Lststs Doueqc Required Parameter Group Authorities and Locks Object type OBJP0100OBJP0200 User name Section User Space Variables User Field DescriptionsAttribute Input User space &4 in &9 damaged Service Program Library &2 ended. Reason codContinuation handle not valid for Object Type Not Valid Error Conditions ParametersOPM Without Pointers-ILE This Program Calls Log Software Error QpdlogerPointers Ffdc Output None Exceptions Ffdc Input Unexpectedhdlr Function \HANDLE 6System API Programming V4R1 QCLE/H Software Error ILEAPI with Pointers-ILE C Example \ Unexpectedhdlr \ Function SymptommsgkeywordMSGSYMPTOMLEN \HANDLE Numberofkeys, &ErrorCode 12System API Programming V4R1 Interface Interface Instructions-IntroductionMachine Section Discussing Setting the Entry PointSetting the Declare Statements Writing an MI Program-Example Result ITS2ARG2 Cpynv MI01 Program-Complete Code Example Compiling a Program Rexx Using Clcrtpg to Create Creating the MI Example Program Testing MI01 RST ProgramDebugging the MI Program SAV Language Statement Such Are Compilers HLLs. BreakBRK Directive allows users Handling Exceptions in the MI Program Hexadecimal representation of the message id String 1202 Where 0C12 =andX 02 02= .X While mostFollowing is an updated view of the MI01 program Excid 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 Following, however, are new statements CodeDeclaring the Structure Understanding the Micrtpg Program by Declaring Pointers UsrspcobjUsrspc Enhanced Version Understanding the MICRTPG2 Program by Sections of CodeCreating the Micrtpg Program Calling Instruction stream, create the space Establish addressability to the Crts template Binoffset OvrdbfQcmdexc API CLOVRLNG@ ARG DCL DD Cldltcmd CHAR12 Initdltovr MisrcDCL Spcptr CLOVRLNG@ Initclovrlng DCL Spcptr CLDLTLNG@ Initcldltlng Beginning the Instruction Stream To Your AdvantageStorage Indicate that the program is done MICRTPG2 Complete Program-MI Code ExampleDelete the previous Ovrdbf Call the Qprcrtpg API to create the MI program DCL Spcptr Usrspc DCL Sysptr USRSPC@ DCL DD Numparms BIN DCL Sysptr QTEMP@ Baspco Crts MIDCL Spcptr PGMOPTS@ Initpgmopts DCL DD Numopts BIN4 INIT3 DCL VAR&OFFSET TYPE\DEC LEN15 Loop Rcvf Updated CL06 ProgramFollowing is the updated CL06 program PGM PARM&BUFFER &OFFSET Dclf Filemisrc DCL Creating the MICRTPG2 Handling ExceptionsQtemp Its Consolidated State This Is the new MICRTPG2 program Example Machine Interface Programming7-29 CTXQSYS, Typepgm Retexcpd INT DCL Sysptr QTEMP@ Defpco MI Common Programming Techniques-ExamplesEntry \ EXT DCL Spcptr SEPT@ Defpco DCL DD Sbytavl DCL DD Matctxopts CHAR44 DCL DD MatctxctlPOS DCL DD Sreceiver CHAR8 BDRY16 DCL DD Sbytprv DCL DD Objentry DCL DD LextattrDeflreceiver DCL DD Lentry Cpynv LBYTPRV, Sbytavl SRECEIVER@, QTEMP@, MatctxoptsCmpnvb SBYTAVL, 96 / Eqdone LRECEIVER@, Sbytavl AS/400 Program Storage Process Allo Cating Initializing automatic StorageAPI before Developing Your Cations APIs Backup Recovery Is only provided Service Program Communications APIsProvides Way to That OptiConnect APIs Configuration APIsReturns a list of configuration descriptions, based on a Debugger APIs Debugger Low-level servicesWindow services Dynamic Screen Manager APIs An edit Code Session servicesEdit Function APIs File APIs Hierarchical File System Hardware Resource APIsQdls ILE CEE APIs Cobol APIs Commitment Control APIs Journal and Commit APIsMessage Handling APIs Journal APIs Data National Language Support APIsNetwork Management APIs National Language Support APIs Alert APIs SNA/Management Services Transport SNA/MS Transport APIs Change Request Management APIs Object APIsNode List API Filter Clear Data Queue Qclrdtaq Retrieve Description LifoFollowing describes User Index APIs 8APIs-13Usridx Chglibl Object APIs Conversion Exit Programs Which Are Discussed Under Office Office APIsMovobj Allows you to rename and mov File Server APIs Office Exit ProgramsMSF Most Functions Performance Collector APIsPrint APIs Print APIs Filtering Problem Management APIs Error Reporting APIs Program and CL Command APIsWorking with a Problem Problem Log Entry APIs Software Product APIs Security APIs UNIX-Type APIs Environment Variable APIsGetenv Queues Integrated File System APIsInterprocess Communication APIs Has Exec Function Are identifie Signal APIsAn X/Open Specification As a mechanism by which a process Semaphore Action Signal MIB IDa Server Client Sockets APIs UIM User Interface APIsProcess-Related APIs UIM Advantages Support DDS AdvantagesWork Work Management APIs Process Miscellaneous APIsMiscellaneous APIs List APIs Find Field Numbers List Qgyoljbl API Task Programming errors and refers you toThat show you how to avoid Errors Using the error code Is shown at .2/locationinthe incorrect and correct coding Using the Error Code ParameterIncorrect Xxxxxxx Csetonlr Using the Error Code Parameter-Example of Correct CodingCall Quscrtus Parm Spcnam Parm SIZ Intval Parm \ALL Parm Extattrextatr 1ð Length Through This Defining Data StructuresIncorrect Coding Length is Defined Through Jstat \ SET UP to Accept Exceptions ADD\ZEROSJobnbr Jobid Defining a Data Structure-Example Coding List Entry from the Space Intval \ SET UP to Accept Exceptions ADD\ZEROS\ Create the Space to Hold the Data Call Quscrtus \ Call the API to List the Active Jobs Qusljob \ Delete the Space That Held the Data RPG When Defining Receiver VariablesWhen Run Lists All Active Jobs System May Written Over with These extra characters. On Call Qusbn \ Retrieve the List Entries Qusbpq ADD Start Qusbn \ Call the API to List the Active Jobs QusljobQusbn \ Retrieve the Offset ADD1 Start \\ JOB Name Structure for Calling Qusljob Ijobnam \ALL Qusgen Qusbn \ Retrieve List Entries Qusbpq ADD Start Defining Incorrect\\ Data Structure Containing Space NAME/LIB Ispcnam DS ADD1 Dowlequsbps Qusbn \ Call the API to List the Active Jobs Format Lengths-Example Correct CodingMovelqusdd Recvr Recvr ADD Start END \ Delete the Space That Held the Data ADD\ZEROS Null NullILE 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 Point For Beginning Read User Using Offsets in a User SpaceUsing Offsets in a User Incorrect \FLAG Reason Level Date Pgmr Iobject \ALL Copy QSYSINC/QRPGSRC,QUSLOBJIusersp APIUG1 Qgpl Lendta Qusbpj Ifeq C Oreq PQusbps ADD1 Count Addqusbpq Strpos Using Offsets in a Correct CodingUser Space-Example \FLAG Reason Level Date Pgmr Iusersp APIUG1 Usrspc Qgpl Spclib Iobject \ALL Objnam Qgpl ObjlibCall Quscrtus Parm Qusbpq ADD Strpos Oreq Exsr Errcod Seton Retrn For Coding for New Function Dspcname Inzadopts Qtemp Dspcsize Dspcinit\FLAG Reason Qusfn QusuaQussgh Qussrl QSYOBJT12 QSYPgmr Change Description Dqsyobjph Basedlstptr Qusis Ifeq Oreq Proces BegsrMove Qusis Lststatus Doueq Exsr Done END Qusis IfeqEval Lstptr = %ADDRARRQUSOIP + END Else Qusei Ifeq Eval Qusbprv = %SIZEQUSECCall Qusrobjd Parm Rcvvar Rcvvarsiz Robjdfmt Parm Spcname \USRSPC Objtype Qusec Coding for New Function-Example Correct Does Not matchPGM, or 9B ð INZ1 Basedspcptr Lupa 46System API Programming V4R1 Dsply Else Else QSYOBJT12 Ifeq Ifeq \BLANKS Move QSYOBJT12 Ifeq \SRVPGMEval Lstptr = Addrarrqussee + END Eval Lstptr = Addrarrqusoip + Parm Qusec Call Qsylobjp Parm SpcnameMbrlist Parm \CURRENT Usrprf Objtype Parm Parm \USER Spcdomain Packaging Your Own Software Products Software productsRPG Example on page A-3 Dltlib ABC Packaging aObject Description CL Program for Crtpnlgrp ABC/ABCPNLGRP ABCDEV/QPNLSRC + Crtdspf ABC/ABCDSPF ABCDEV/QDDSSRC +Crtpf ABC/ABCPF ABCDEV/QDDSSRC + Crtcmd ABC/ABC ABC/ABCPGM ABCDEV/QCMDSRC + Copy QSYSINC/QRPGSRC,QSZCRTPD Phone Copy QSYSINC/QRPGSRC,QSZCRTPLCopy QSYSINC/QRPGSRC,QSZPKGPO Textd Qszbcb Exsr CobjdExsr Pkgpo Prddfn Begsr Parm Qszbf MovelqszcrtpdapiParm Qszbc Parm Qszbd Qszbk Movelqszcrtplapi Call QszcrtplQszbh Qszbj Pkgpo CobjdMove OBJ,I Objds Name CAT ABC Cobji Parm \NO MOVEL\ALL QszbrfMovelqszpkgpoapi Call Qszpkgpo Parm Qszbr Parm \YES Repkg Command B-129 Qszrtvpr APIRetriev Rtvfd \CHANGE \INT \LCL Using Data Queues versus UserQueue entries are manipulated. F Data Queue-ILE C Example User Queue-ILE C Example QueuelibExample 18System API Programming V4R1 Valid \USER Appendix A. Performing Tasks Using APIs-ExamplesA-21 22System API Programming V4R1 Additional Languages Appendix Jobdapi Original Program Model OPM APIs-ExamplesHold Parameter Exception Message-ILE C Example on For the original Appendix Original Examples in Additional Identification Division Message-ILE Cobol Copy Qusec of QSYSINC-QLBLSRC Procedure Division Using JOBD, JOBDL. .8/ MAIN-LINECobol PROGRAM-ID. Jobdapi Environment Division Move Jobd to JOB-DESC. Move Jobdl to JOB-DESC-LIB Move HOLD-JOB-QUEUE to HoldCopy QSYSINC/QRPGLESRC,QUSEC Dformat DcmdstringINZ Tousrqpgmr Drcvlen Handling Error Call Qwdrjobd Exsr ErrorError Begsr Jobd CAT Jobdlib Lfnam Jobdapi Appendix B. Original Examples in Additional BLanguages-11 Identification Division Procedure Division Using JOBD, JOBDL. MAIN-LINE Move 16 to BYTES-PROVIDEDPerform Errcod Copy QSYSINC/QRPGLESRC,QWDRJOBD Call Qcmdexc Using MESSAGE-TWO, COMMAND-LENGTH, Stop RUN Call Qwdrjobd Parm DCMDSTR2Msgid INZ Tousrqpgmr Dlenstr INZ%SIZECMDSTRING DLENSTR2 INZ%SIZECMDSTR2 Accessing the Hold Attribute-ILE C Example Movel Qusei Msgid Call Qcmdexc ParmParm LENSTR2 Endsr File PROGRAM-ID. Jobdapi Hold Attribute-ILE LIST-LINE Data Division File SectionLabel Records are Standard Data Record is LIST-LINE BAD Open Output Listing Move EXCEPTION-ID to Msgid Attribute-OPM RPG Example On page 3-17 f Original Refer To Accessing Oqprint BAD Except Good ElseExcept BAD END Oqprint Good Appendix B. Original Examples in Additional 24System API Programming V4R1 Refer Accessing Field Value Initial Library List-OPM List-ILE Cobol ExampleFor Original example. The following program also Value Qwdrjobd Roch BYTES-AVAILABLE JOB-SWITCHES PICDEVICE-RECOVERY-ACTION PIC BYTES-RETURNED Perform NUMBER-LIBS-IN-LIB-LIST Times Call Qcmdexc Using COMMAND-STRING, COMMAND-LENGTH, ADD 11 to Reclen List-ILE RPG Qwdbavl Qwdbrtn Qwdjd QwdjdnQwdjdln Qwdun Qwdjmqfa QwdordQwdlrd Qwdjmqms Call Qcmdexc Parm Cmdstring Lenstr ADD Using Keys with ListExsr Error Else Qwdoill ADD Qwdnlill Eval Quslspl Appendix B. Original Examples in Additional BLanguages-35 36System API Programming V4R1 Appendix B. Original Examples in Additional BLanguages-37 Pages Using Keys with List Spooled Files API-ILE Cobol ExamplePrtfil PIC Filler PIC Misc SPC-NAME PIC Opndat PICLsterr TEXT1 PIC Hdrerr TEXT2 PIC Procedure DIVISION. MAIN-LINE Call Qusptrus Using SPC-NAME, SPCPTR, QUS-ECKEY-INFO Perform Proces SETSTRING-SPACE Spcptr SET STRING-SPACEOFFSET-LIST-DATA Dlstptr DLSTPTR2 Dspcptr Using Keys with List Spooled Files API-ILE RPG ExampleTo Opndat Inzspcname Qtemp Dspcsize Appendix B. Original Examples in Additional BLanguages-43 \ QUSERVED35 DqussplkiBASEDLSTPTR2 \QUSERVED34 Format Parm \CURRENT Usrprf Parm \BLANKS SpctextParm Qusec \USER Call Quslspl Parm Spcname Move \BLANKS Prtfil Eval AGE CAS Error ENDEval LSTPTR2 = %ADDRARRX END Except Prtlin Filnam Begsr Integrated APIs-ExamplesExit Cobol Example VAR-OFFSET BAD-REG TEXT1 PICEXCEPTION-ID PIC BAD-ADD TEXT1 PIC Move 4 to CONTROL-KEY of QUS-VLEN-REC-4 Move 2 to NBR-RECORDSMove 3 to CONTROL-KEY of QUS-VLEN-REC-4 Move Exit Point Example 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 Iovrlay Printer \ Compile Time Array RECCopy QSYSINC/QRPGSRC,QUS I\ Ivarrec Binary ADD Moveabinc REC,OF Exsr Calcvo ADD8 ADD2ADD3 ADD4 Qusbnc Ifgt Open REC,OF ExsrADD37 Binary Moveabinc REC,OF Exsr Call Qusaddep Copy QSYSINC/QRPGLESRC,QUS ErreptErrpgm Printer OFLIND\INOF Usropn Doverlays Binary Dvarrec NbrrecsRecs Dvoffset Open Qprint Except Erraepnt Exsr Done Endif CallbParm Epntname Format Parm Varrec Qusec Information-OPM Cobol Misc EXIT-POINT-NAME PIC PROGRAM-ID. REGFAC2 Environment DivisionEXCEPTION-ID BAD-CREATE TEXT1 Value Rcvvar Qtemp SPACE-ATTR PIC FORMAT-NAME-1 PICFORMAT-NAME-2 PIC BASE-POINTER Pointer INFO-POINTER SPACE-NAME PIC Move Spaces to CONTINUATION-HDL Call Qusptrus Using SPACE-NAME, BASE-POINTER, QUS-EC CALL-EXIT-PROGRAMS Else Stop RUNPerform CALL-EXIT-PROGRAMS To CONTINUATION-HDL CALL-PGMS Write LIST-LINE from BAD-EXIT-PGM, Stop RUNTo Address of RCVVAROFFSET-PROGRAM-ENTRY Perform CALL-PGMS Value Exampleexitpoint EXIT-PGM-NBRValue -1 Binary 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 Call Qusrtvei Parm Conthd RCV Rcvsz Copy QSYSINC/QRPGSRC,QUSREGIrcv Move \BLANKS SUBSTRCV1 Parm EpntnmParm Epgmnb Qusccb Quscjg Parm RCV RcvszQuscj ADD Quscjf Substrcvy \ Based Information-ILE RPG ExampleDone Begsr Seton Retrn Endsr Oqprint Qusbnd Oqprint Qusppf DquspeQusppn Quspplib Qusco QusmlibQusmi Dqusse Qusacc QusmepQusnbrep Qusad Quspgml QusoneQusce Quspgmn Quslpgme Qusled\QUSPD Qusopgme Quslpd QUSFN12Qusmfill Qusopd Depntname Inzexampleexitpoint Depgmnbr \ QUSFN13\ QUSERVED11 Qusrei Epntfmt Parm Epgmnbr Qusnbrsc Qusec Move \BLANKS ContinhdlCallb Qusrei Parm Continhdl Rcvvar Rcvvarsz Format Parm Epntname DOW Exsr Cusrei Enddo Endif DoneCusrei Begsr Begsr Eval Remove Exit ProgramParm Exitparms Eval Infspcptr = %ADDRRCVVARQUSONE+1 Enddo Endsr 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 Qusrepgm Parm Epntname Format Parm Pgmnbr QusecCallb Qusdep Parm Epntname 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 List Object API-ILE Cobol Example PROGRAM-ID. Listadopt Environment DivisionINPUT-OUTPUT Section 102 Address of STRING-SPACE Procedure Division Using USR-PRF, OBJ-TYPE. MAIN-LINEOBJ-TYPE PIC Copy Qsylobjp of QSYSINC-QLBLSRC Perform PROCES2 To LST-STATUS, END-IF END-IF, END-IF ElsePerform DONE, END-IF PROCES2 Move Qusrobjd to APINAM, Perform Apierr Move Qsylobjp to APINAM, Perform ApierrMove Length of QUS-EC to BYTES-PROVIDED of QUS-EC Move Quscrtus to APINAM, Perform Apierr Write LIST-LINE from END-LIST. Stop RUN 106Move Qusptrus to APINAM, Perform Apierr Display Apinam Display EXCEPTION-ID of QUS-EC. Perform Done Dlstptr Dspcptr Darr Basedlstptr DIM32767 Drcvvar Inzadopts Qtemp Dspcsize QSYOBJT14 108QSYOBJT13 QSYOBJA11 Qusnbrle Except Objentry Eval Lstptr = %ADDRARRQUSSEE + 1 ENDLststatus Exsr Getlst Move Qusis Lststatus END Else Mbrlist Parm Usrprf Objtype Continhdl QusecRobjdfmt Parm Spcname \USRSPC Spctype Qusec CPF98ð1 Logging Pointers-ExamplesCBLERR1 Program Without ERROR-HANDLER PIC PROGRAM-ID. CBLERR1ERRHDL1 \LIBL Scope PIC PROGRAM-ID. ERRHDL1 PRIOR-ERROR-HANDLER of MISC, QUS-ECERRHDL1 Program ADD X to Y Binary Value PRINT-JOBLOG PIC Misc LOG-EXCEPTION-ID PICMESSAGE-KEY PIC POINT-OF-FAILURE PIC Move C to SYS-OPTION. Stop RUN Logging Software Error OPMMove 1 to MSG-OFFSET LIBRARY-NAME Imisc SRC TGTIpsds Excpid FACT1 DIV FACT2 Result SwitchFACT1 FACT2 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 Reporting This section includes the examples Reporting Software ErrorRefer to Reporting Software Error ILE CBLERR2 Program ERROR-HANDLER Copy Qusec of QSYSINC-QCBLLESRCNUMERIC-GROUP PIC ERRHDL2 Program PROGRAM-ID. ERRHDL2Copy Qpdsrvpg of QSYSINC-QCBLLESRC CBL-PGM-NAME Procedure Division Using CBL-EXCEPTION-IDMESSAGE-LENGTH SYS-OPTION PIC RPG Example 126Software Copy QSYSINC/QRPGLESRC,QPDSRVPG D\ InzrcDpsds 128System API Programming V4R1 This Section Includes the examples Packaging Your Software ProduSftwprdex 130System API Programming V4R1 Object ABCðð29 MRI object For Product 132System API Programming V4R1 Qclsrc ABC ABCPGMMRM2ABCABCPGMMRI1ABC ABCPGMMRI2ABC 134 Appendix B. Original Examples in Additional BLanguages-135 PROGRAM-ID. Sftwprdex Environment Division Program for Packaging a Product-ILE Cobol ExampleQszcrtpd Qszpkgpo API-NAME PIC Copy Qszcrtpd of QSYSINC-QLBLSRCCopy Qszcrtpl of QSYSINC-QLBLSRC Copy Qszpkgpo of QSYSINC-QLBLSRC PID13 PIC NumkeyKEY13 LEN13 Prddfn Perform PrdlodPerform Cobjd Perform Pkgpo Prdlod Call Qszcrtpd Using PROD-NAME, QSZ-PRD-INF, QSZ-PRD-OPTMove Spaces to Reserved of QSZ-LNG-LOD Move Qszcrtpd to API-NAME, Perform Errcod Move Qszcrtpl to API-NAME, Perform Errcod Move ABCPGMMRI2 to POST-EXIT-PGM of QSZ-LIB-INFMove ABCPGMMRI1 to PRE-EXT-PGM of QSZ-PRE-EXT Move Qlicobjd to API-NAME, Perform Errcod Call Qszpkgpo Using QSZ-PRD-OPT-INF, REPKG, ALWCHG, QUS-EC Move Qszpkgpo to API-NAME, Perform ErrcodOpen Output LISTING, Move 1 to FIRST-ERR Product-OPM RPG Example on page A-3 fo Original 144Packaging a Refer To Program For Dapiname Dfirsterr Dcobji NumkeyPID13 KEY12 LID12 KEY5 Parm Prodname Qszpi Qszpo 146Eval Qszamr = \NO Qszridt = \PHONE Eval Qszadn = \NODYNNAM Eval Qszlt = \CODE Qszlid = \CODEDFT Parm QszllParm Pubaut Qusec Exsr Errcod Endif Endsr 148 Parm Qszal Parm Qszpe Nbrpe QszflCobjd Begsr 150 Qusei \\CTDATA Objinfo Open Qprint Eval Firsterr = EndifEndsr Oqprint Badnews Apiname SPACE-INIT PIC Space-ExamplesSpace-ILE Cobol Example FILE-USED PIC EXT-ATTR PIC Overrides PICSystem PIC FORMAT-1 PIC Display API-NAME Call Qusptrus Using SPACE-NAME, SPACE-POINTER, QUS-ECAPI-ERROR-FOUND SET Address of QDB-QDBFH to SPACE-POINTER To a User Space-ILE RPG Example 156 Qdbfwtfi QdbfhuplQdbfhmxm \NOMAX QDBRSV11 QdbfhfrtFrcratio Qdbhmnum Qdbfhcrt Qdbfvrm\QDBQAAF2 QDBBITS31 QDBRSV17 160 QDBRSV24 QDBRSV23Qdbffigl Qdbfmxrl Qdbpfof Fcfo Fifo LifoQdbfhrls QDBRSV27 Dsystem INZ\LCL DFORMAT1 INZ\INT Dchgattr Nbrattr QDBRSV28Dspcname Dfilename Dfmtname Dfileused Dlibname Dspcsize Dspcptr Dformat Doverrides Qusbavl Ifgt Movel Quscusat Apinam Exsr Apierr END Call Quscrtus Parm Spcname \BLANKS ExtattrSpcsize Parm Spcinit \CHANGE Spcaut Qdbrtvfd Spctext Call Quscusat Parm Libname Spcname Chgattr Qusec Data Queue-ILE Cobol Example Data Queue-Examples Crtlib FIRST-ERROR PICPROGRAM-ID. Dqueuex Environment Division Copy Qcapcmd of QSYSINC-QLBLSRC WAIT-TIME MSG PICMSG-BACK PIC ERROR-FOUND Move 1 to FIRST-ERRORDisplay MSG-BACK Data Queue-OPM RPG Example 170 Qcabc Exsr ExccmdMoveldltlib Cmdstr Exsr Exccmd Seton Retrn 172 Data Parm Exampleq Eval Qcamk = \BLANKS Qcaerved = \LOVALEval Cmdstr = Crtlib Lenstr = %SIZECRTLIB Exsr Execcmd Eval Cmdstr = Crtdq Lenstr = %SIZECRTDQ Exsr Execcmd 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 Curdir PRT-TEXT PIC PROGRAM-ID. IFS Environment DivisionPRT-TEXT PIC User PIC Oflag PIC Procedure DIVISION. MAIN-LINE Open Output ListingTestfile Value LOW-VALUE If RETURN-INT Perform ERROR-FOUNDTo LIST-LINE Write LIST-LINE Giving RETURN-INT To LIST-LINE Perform ERROR-FOUND To LIST-LINE Perform ERROR-FOUND ElseWrite LIST-LINE. Stop RUN 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 Other countries+1+507+253-5192 How satisfiedPlease tell us how we can improve this manual To return this form SC41-5800-00 Reader Comments-Wed Like to Hear from YouPage IBM IBM