Manuals / IBM / TV and Video / Universal Remote

IBM Version 4 manual 12System API Programming V4R1

Models: Version 4

1 505

Download 505 pages 30.92 Kb

Page 140

6-12System API Programming V4R1

Image 140

IBM Version 4 manual 12System API Programming V4R1

Contents

IBM Page IBM First 1997Contents Chapter HoldRPG AcrossAPIs ProgrammingMICRTPG2 OPM CobolIndex ViiOPM API Viii System API Programming V4R1 Micrtpg System API Programming V4R1 Disclaimed IBMImplied Warranties of Merchantability and Fitness for Programming Interface Information TrademarksUse XiiiPrerequisite HLLXiv System API Programming V4R1 Exit programs That are documented Systemin API CompatibilityAPI Compatibility Using APIs-Benefits Saved Overhead Processing When You CallBecause You Not Have To go ThroughSystem APIs or CL Commands-When Use APIsFunctions Cobol ILE RPGRelated Information EnvironmentsBesides the OS/400 APIs that are OS/400 APIs Are documented Following booksStarted Locating the API toSocket Network Functions This UnixVerb Selecting the High-Level Language To Use Language Selection Considerations Data TypesAPI Environments APIs for the Integrated Language Environment Environment CEERelated Information APIs for the ILE CommonIntegrated Language Environment ILE CEE APIs APIs for the Unix EnvironmentAPI Parameters Parameter Passing Value of the data object is placed directlParameter List LanguaError Code Parameter Parameter ClassificationReceiving Error Conditions as Exceptions-Example ErrorWith Exception Data-Example CodeErrors FromGetting Started with2-11APIs Security Uses Internal IdentifiersSpooling User Spaces User SpacesSpace Used byUser Space Format-Example XxxxLogic Flow of Processing a List of Entries +NOUsing Offset Values with Pointers WithManipulating a User Synchronizing between Two or More JobsManipulating a User Space without Pointers Position ValuesLengths Space APIsQuschgus API Following is a user space after you change it with one Changing a User Space with an ILE RPG Program-Example \ Program ChangusptrChanging a User Space with an OPM RPG Program-Example RPGList UserListing Additional Information aboutReceiver Variables Bytes Returned FieldsBeginning A receiver variable or the beginning of aKeyed Interface Qusljob APIUsing a Continuation Handle User Space AlternativeContinuation Handle Qlicobjd APIMore information Domain ConceptsAPI Exit Points Security, Qalwusrdmn Set to System configured forsystemC2Exit Programs APIs and the Qsysinc LibraryInclude File CcsidCompile Program Specific APIs and the Qusrtool Library User Index ConsiderationsUser Index Considerations InSystthem API Reference, SC41-5801System Performance ConsiderationsPerformance Considerations 32System API Programming V4R1 Information Original Program Model OPM API-ScenarioJob Held Queue First Step Finding the correct API is to Identify Part ThatDescription of an API ParametersLocks AuthoritiesAre Based Objects That Performs Object ForAre described in Required Parameter Group Format You Can See fromDecthedecimal Offset ColumnBecause the field is a binary Would Make Binary ValueCan Place Format Name Pass Literal This NameError Messages FormatField Descriptions Optional Parameter GroupExample Hold ParameterPerspective Only Possible values For Hold Job Queue Field AreAPIs-Examples Handling Error Conditions-OPM RPG Example Call Jobdapi Parmqbatch QgplCall Jobdapi Parmqbatch \LIBL Call Jobdapi Parmxyz \LIBLIpgmsts SDS Msgidd OPM RPGITOUSRQPGMR36 47 MSG3B Error ParameterFormat Error code structure Qusbn is Error Code Structure Can FoundCommon Information across APIs-Basic OPM 3-Example13 Qgpl Call Jobdapi Qpgmr XYZ XYZLibrary Does Not Exist. Use the following call statement Value Placed Level Date Pgmr Change DescriptionCode used to access the Hold attribute. T Accessing the Hold Attribute-OPMDiagnostic Message exists Job Log Can Received Error-code data structure Following data structures are usedRetrieve job description data structure StructureInitial Information across APIs-Basic OPM 3-Example\$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 Qusrtvus QusptrusAPI-Example ProcessingJob Description Information ParametersJOBD0100 Format CHAR8 End Severity BytesBytes Returned Reply Job dateJob LibraryYES MSGOffset 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 Exit Program Attribute Keys Key Type FieldError Handling Error Handling through the Error Code ParameterCcsid Initialize Bytes provided Field Number ParameterSecond Exception handling is by having All Exceptions SignaReceiver Variables-Examples EntryWith Fields-ExampleILE C Registration Facility Using ILE APIs-ExamplesAdd Exit Program-ILE Description \EXCLUDEAPI Exit Point Example12System 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 Remove Exit Program and Deregister Exit Point-ILE C Example Language ILE C Description20System API Programming V4R1 Errorcode.ecfields.ExceptionId Exit1 \ End program \ 22System API Programming V4R1 Characteristics of a List General Data StructureOffset to List Data Section General Data StructureOther Fields of Generic Header On page 5-14 and the OBJP0200 Format on 5-14. ThisQsylobjp API Can Locate Remaining Information PlaceSee 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 Qusbnf QusbngIqusky Quskyf\ENTRY Plist Parm Exsr Init Exsr Proces Exsr DoneBegsr Call QsylobjpParm Rjobdf Parm SpcnamParm Spctyp QusbncADD Qusbpq Strpos PROC2Sizent QSYB6Nument Exsr PROC2 Qusbpj IfeqADD Qusbpl Strpos Movelqusrtvusapinam Exsr Apierr EndifEndif USRSPC=P/C Endsr Begsr Movelqusbpj LststsDoueqc Oreq Exsr PROC1Authorities and Locks Required Parameter GroupOBJP0100 OBJP0200User name Object typeUser Space Variables SectionField Descriptions AttributeInput UserService Program Library &2 ended. Reason cod Continuation handle not valid forObject Type Not Valid User space &4 in &9 damagedOPM Error ConditionsParameters This Program Calls Log Software Error Qpdloger PointersFfdc Without Pointers-ILEOutput None Exceptions Unexpectedhdlr Function Ffdc Input\HANDLE 6System API Programming V4R1 Software Error ILE API with Pointers-ILE C Example\ Unexpectedhdlr \ QCLE/HFunction SymptommsgkeywordMSGSYMPTOMLEN \HANDLE Numberofkeys, &ErrorCode 12System API Programming V4R1 Machine InterfaceInterface Instructions-Introduction Setting the Entry Point Setting the Declare StatementsWriting an MI Program-Example Section DiscussingITS2 ARG2Cpynv ResultCompiling a Program MI01 Program-Complete Code ExampleUsing Clcrtpg to Create RexxTesting MI01 Creating the MI Example ProgramProgram Debugging the MI ProgramSAV RSTAre Compilers HLLs. Break BRKDirective allows users Language Statement SuchHandling Exceptions in the MI Program String 1202 Where 0C12 =andX 02 02= .X While most Following is an updated view of the MI01 programExcid Hexadecimal representation of the message idCreating an MI Version of Clcrtpg Qprcrtpg .API Program Flow for Creating the Micrtpg ProgramSource for CL03 follows Source for CL04 followsSource for CL05 follows Source for the Micrtpg Program Source for Micrtpg followsCode Declaring the StructureUnderstanding the Micrtpg Program by Following, however, are new statementsUsrspc Declaring PointersUsrspcobj Understanding the MICRTPG2 Program by Sections of Code Creating the Micrtpg ProgramCalling Enhanced VersionEstablish addressability to the Crts template Instruction stream, create the spaceQcmdexc API BinoffsetOvrdbf DCL DD Cldltcmd CHAR12 Initdltovr Misrc DCL Spcptr CLOVRLNG@ InitclovrlngDCL Spcptr CLDLTLNG@ Initcldltlng CLOVRLNG@ ARGStorage Beginning the Instruction StreamTo Your Advantage MICRTPG2 Complete Program-MI Code Example Delete the previous OvrdbfCall the Qprcrtpg API to create the MI program Indicate that the program is doneDCL DD Numparms BIN DCL Spcptr Usrspc DCL Sysptr USRSPC@DCL Spcptr PGMOPTS@ Initpgmopts DCL DD Numopts BIN4 INIT3 DCL Sysptr QTEMP@ BaspcoCrts MI Updated CL06 Program Following is the updated CL06 programPGM PARM&BUFFER &OFFSET Dclf Filemisrc DCL DCL VAR&OFFSET TYPE\DEC LEN15 Loop RcvfQtemp Creating the MICRTPG2Handling Exceptions Example Its Consolidated State This Is the new MICRTPG2 programMachine Interface Programming7-29 CTXQSYS, Typepgm INT RetexcpdMI Common Programming Techniques-Examples Entry \ EXTDCL Spcptr SEPT@ Defpco DCL Sysptr QTEMP@ DefpcoDCL DD Matctxopts CHAR44 DCL DD Matctxctl POSDCL DD Sreceiver CHAR8 BDRY16 DCL DD Sbytprv DCL DD SbytavlDCL DD Lextattr DeflreceiverDCL DD Lentry DCL DD ObjentrySRECEIVER@, QTEMP@, Matctxopts Cmpnvb SBYTAVL, 96 / EqdoneLRECEIVER@, Sbytavl Cpynv LBYTPRV, SbytavlAPI before Developing Your Cations AS/400 Program StorageProcess Allo Cating Initializing automatic Storage Backup Recovery APIsProvides Way to That Is only provided Service ProgramCommunications APIs Configuration APIs Returns a list of configuration descriptions, based on aDebugger APIs OptiConnect APIsLow-level services Window servicesDynamic Screen Manager APIs DebuggerSession services Edit Function APIsFile APIs An edit CodeQdls Hierarchical File SystemHardware Resource APIs Cobol APIs ILE CEE APIsJournal and Commit APIs Message Handling APIsJournal APIs Commitment Control APIsNational Language Support APIs Network Management APIsNational Language Support APIs DataSNA/Management Services Transport SNA/MS Transport APIs Alert APIsObject APIs Node List APIFilter Change Request Management APIsFollowing describes Clear Data Queue Qclrdtaq Retrieve DescriptionLifo Usridx User Index APIs8APIs-13 Object APIs ChgliblOffice APIs MovobjAllows you to rename and mov Conversion Exit Programs Which Are Discussed Under OfficeMSF File Server APIsOffice Exit Programs Performance Collector APIs Print APIsPrint APIs Most FunctionsProblem Management APIs FilteringProgram and CL Command APIs Working with a ProblemProblem Log Entry APIs Error Reporting APIsSecurity APIs Software Product APIsGetenv UNIX-Type APIsEnvironment Variable APIs Integrated File System APIs Interprocess Communication APIsHas Exec Function QueuesSignal APIs An X/Open Specification As a mechanism by which a processSemaphore Are identifieSignal ActionIDa MIBSockets APIs Server ClientUser Interface APIs Process-Related APIsUIM Advantages UIMDDS Advantages WorkWork Management APIs SupportMiscellaneous APIs Miscellaneous APIsList APIs ProcessQgyoljbl API Find Field Numbers ListProgramming errors and refers you to That show you how to avoid ErrorsUsing the error code TaskUsing the Error Code Parameter IncorrectXxxxxxx Is shown at .2/locationinthe incorrect and correct codingUsing the Error Code Parameter-Example of Correct Coding Call Quscrtus Parm SpcnamParm SIZ Intval Parm \ALL CsetonlrParm Extattrextatr 1ð Defining Data Structures Incorrect CodingLength is Defined Through Length Through This\ SET UP to Accept Exceptions ADD\ZEROS JobnbrJobid JstatCoding Defining a Data Structure-ExampleIntval \ 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 List Entry from the Space\ Delete the Space That Held the Data When Defining Receiver Variables When Run Lists All Active Jobs SystemMay Written Over with These extra characters. On Call RPGQusbn \ Call the API to List the Active Jobs Qusljob Qusbn \ Retrieve the OffsetADD1 Start Qusbn \ Retrieve the List Entries Qusbpq ADD StartQusgen \\ JOB Name Structure for Calling Qusljob Ijobnam \ALLQusbn \ Retrieve List Entries Qusbpq ADD Start \\ Data Structure Containing Space NAME/LIB Ispcnam DS DefiningIncorrect Qusbn \ Call the API to List the Active Jobs ADD1 DowlequsbpsCoding Movelqusdd RecvrRecvr ADD Start END \ Delete the Space That Held the Data Format Lengths-Example CorrectADD\ZEROS ILE NullNull Using Null Pointers with OPM APIs-Example of Correct Coding 20System API Programming V4R1 \CURLIB Byte Correct Byte Alignment ensures that data used With anQusVlenRec4t descrec Char Desc5ð Addepattributes This is a Test Exit PROGRAM,27 Defining Byte Alignment-Example Correct ILE CEXAMPLEPGMEXAMPLELIB, Example Exit Program Data Using Offsets in a User Space Using Offsets in a UserIncorrect Point For Beginning Read User\FLAG Reason Level Date Pgmr Copy QSYSINC/QRPGSRC,QUSLOBJ Iusersp APIUG1Qgpl Iobject \ALLQusbpj Ifeq C Oreq P QusbpsADD1 Count Addqusbpq Strpos LendtaUser Space-Example Using Offsets in aCorrect Coding \FLAG Reason Level Date Pgmr Call Quscrtus Parm Iusersp APIUG1 Usrspc Qgpl SpclibIobject \ALL Objnam Qgpl Objlib Oreq Qusbpq ADD StrposExsr Errcod Seton Retrn Coding for New Function For\FLAG Reason Dspcname Inzadopts Qtemp DspcsizeDspcinit Qusua QussghQussrl QusfnQSY Pgmr Change DescriptionDqsyobjph Basedlstptr QSYOBJT12Proces Begsr Move QusisLststatus Doueq Qusis Ifeq OreqQusis Ifeq Eval Lstptr = %ADDRARRQUSOIP +END Else Exsr Done ENDEval Qusbprv = %SIZEQUSEC Call Qusrobjd Parm Rcvvar RcvvarsizRobjdfmt Parm Spcname \USRSPC Objtype Qusec Qusei IfeqPGM, or Coding for New Function-Example CorrectDoes Not match 9B ð INZ1 Lupa Basedspcptr46System API Programming V4R1 Else QSYOBJT12 Ifeq Dsply ElseQSYOBJT12 Ifeq \SRVPGM Eval Lstptr = Addrarrqussee + ENDEval Lstptr = Addrarrqusoip + Ifeq \BLANKS MoveCall Qsylobjp Parm Spcname Mbrlist Parm \CURRENT UsrprfObjtype Parm Parm QusecParm \USER Spcdomain RPG Example on page A-3 Packaging Your Own Software ProductsSoftware products Packaging a Object DescriptionCL Program for Dltlib ABCCrtdspf ABC/ABCDSPF ABCDEV/QDDSSRC + Crtpf ABC/ABCPF ABCDEV/QDDSSRC +Crtcmd ABC/ABC ABC/ABCPGM ABCDEV/QCMDSRC + Crtpnlgrp ABC/ABCPNLGRP ABCDEV/QPNLSRC +Copy QSYSINC/QRPGSRC,QSZCRTPD Copy QSYSINC/QRPGSRC,QSZCRTPL Copy QSYSINC/QRPGSRC,QSZPKGPOTextd PhoneExsr Cobjd Exsr PkgpoPrddfn Begsr QszbcbMovelqszcrtpdapi Parm QszbcParm Qszbd Parm QszbfMovelqszcrtplapi Call Qszcrtpl QszbhQszbj QszbkCobjd Move OBJ,I Objds Name CAT ABCCobji PkgpoMOVEL\ALL Qszbrf Movelqszpkgpoapi Call Qszpkgpo Parm QszbrParm \YES Repkg Parm \NORetriev Command B-129Qszrtvpr API Rtvfd \CHANGE \LCL \INTQueue 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 Appendix Additional LanguagesOriginal Program Model OPM APIs-Examples Hold Parameter Exception Message-ILE CExample on For the original JobdapiAppendix Original Examples in Additional Message-ILE Cobol Identification DivisionProcedure Division Using JOBD, JOBDL. .8/ MAIN-LINE CobolPROGRAM-ID. Jobdapi Environment Division Copy Qusec of QSYSINC-QLBLSRCCopy QSYSINC/QRPGLESRC,QUSEC Move Jobd to JOB-DESC. Move Jobdl to JOB-DESC-LIBMove HOLD-JOB-QUEUE to Hold Dcmdstring INZ TousrqpgmrDrcvlen DformatHandling Error Exsr Error Error BegsrJobd CAT Jobdlib Lfnam Call QwdrjobdJobdapi Appendix B. Original Examples in Additional BLanguages-11 Identification Division Perform Errcod Procedure Division Using JOBD, JOBDL. MAIN-LINEMove 16 to BYTES-PROVIDED Call Qcmdexc Using MESSAGE-TWO, COMMAND-LENGTH, Stop RUN Copy QSYSINC/QRPGLESRC,QWDRJOBDDCMDSTR2 Msgid INZ TousrqpgmrDlenstr INZ%SIZECMDSTRING DLENSTR2 INZ%SIZECMDSTR2 Call Qwdrjobd ParmParm LENSTR2 Endsr Accessing the Hold Attribute-ILE C ExampleMovel Qusei Msgid Call Qcmdexc Parm File Hold Attribute-ILE PROGRAM-ID. JobdapiData Division File Section Label Records are StandardData Record is LIST-LINE LIST-LINEBAD Open Output Listing Move EXCEPTION-ID to Msgid Refer To Accessing Attribute-OPM RPG Example On page 3-17 f OriginalExcept Good Else Except BAD ENDOqprint Good Oqprint BADAppendix 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 Roch Value QwdrjobdJOB-SWITCHES PIC DEVICE-RECOVERY-ACTION PICBYTES-RETURNED BYTES-AVAILABLECall Qcmdexc Using COMMAND-STRING, COMMAND-LENGTH, ADD 11 to Perform NUMBER-LIBS-IN-LIB-LIST TimesList-ILE RPG ReclenQwdbrtn QwdbavlQwdjdn QwdjdlnQwdun QwdjdQwdord QwdlrdQwdjmqms QwdjmqfaUsing Keys with List Exsr Error ElseQwdoill ADD Qwdnlill Eval Call Qcmdexc Parm Cmdstring Lenstr ADDQuslspl Appendix B. Original Examples in Additional BLanguages-35 36System API Programming V4R1 Appendix B. Original Examples in Additional BLanguages-37 Using Keys with List Spooled Files API-ILE Cobol Example Prtfil PICFiller PIC PagesOpndat PIC Lsterr TEXT1 PICHdrerr TEXT2 PIC Misc SPC-NAME PICKEY-INFO Procedure DIVISION. MAIN-LINECall Qusptrus Using SPC-NAME, SPCPTR, QUS-EC SET STRING-SPACE Spcptr SETSTRING-SPACEOFFSET-LIST-DATA Perform ProcesUsing Keys with List Spooled Files API-ILE RPG Example To OpndatInzspcname Qtemp Dspcsize Dlstptr DLSTPTR2 DspcptrAppendix B. Original Examples in Additional BLanguages-43 Dqussplki BASEDLSTPTR2\QUSERVED34 \ QUSERVED35Parm \BLANKS Spctext Parm Qusec \USERCall Quslspl Parm Spcname Format Parm \CURRENT UsrprfAGE CAS Error END Eval LSTPTR2 = %ADDRARRX END Except PrtlinFilnam Begsr Move \BLANKS Prtfil EvalAPIs-Examples ExitCobol Example IntegratedBAD-REG TEXT1 PIC EXCEPTION-ID PICBAD-ADD TEXT1 PIC VAR-OFFSETMove 2 to NBR-RECORDS Move 3 to CONTROL-KEY of QUS-VLEN-REC-4Move Exit Point Example Move 4 to CONTROL-KEY of QUS-VLEN-REC-4By Content Length of EXIT-PGM-DATA of MISC, VARREC, QUS-EC Register Exit PointTEXT1 PIC X1ððð Ð1 Misc EXIT-POINT-NAME of MISC, FORMAT-NAME of MISC, VARREC, QUS-EC RPG Printer \ Compile Time Array REC Copy QSYSINC/QRPGSRC,QUS I\Ivarrec IovrlayADD2 ADD3ADD4 Binary ADD Moveabinc REC,OF Exsr Calcvo ADD8REC,OF Exsr ADD37 Binary Moveabinc REC,OF ExsrCall Qusaddep Qusbnc Ifgt OpenErrept ErrpgmPrinter OFLIND\INOF Usropn Copy QSYSINC/QRPGLESRC,QUSDvarrec Nbrrecs RecsDvoffset Doverlays BinaryCallb Parm EpntnameFormat Parm Varrec Qusec Open Qprint Except Erraepnt Exsr Done EndifInformation-OPM Cobol PROGRAM-ID. REGFAC2 Environment Division EXCEPTION-IDBAD-CREATE TEXT1 Misc EXIT-POINT-NAME PICFORMAT-NAME-1 PIC FORMAT-NAME-2 PICBASE-POINTER Pointer INFO-POINTER SPACE-NAME PIC Value Rcvvar Qtemp SPACE-ATTR PICCall Qusptrus Using SPACE-NAME, BASE-POINTER, QUS-EC Move Spaces to CONTINUATION-HDLElse Stop RUN Perform CALL-EXIT-PROGRAMSTo CONTINUATION-HDL CALL-EXIT-PROGRAMSWrite LIST-LINE from BAD-EXIT-PGM, Stop RUN To Address of RCVVAROFFSET-PROGRAM-ENTRYPerform CALL-PGMS CALL-PGMSValue -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 Copy QSYSINC/QRPGSRC,QUSREG IrcvMove \BLANKS Call Qusrtvei Parm Conthd RCV RcvszParm Epntnm Parm EpgmnbQusccb SUBSTRCV1Parm RCV Rcvsz QuscjADD Quscjf Substrcvy QuscjgInformation-ILE RPG Example Done Begsr Seton Retrn Endsr OqprintQusbnd Oqprint \ BasedDquspe QusppnQuspplib QusppfQusmlib QusmiDqusse QuscoQusmep QusnbrepQusad QusaccQusone QusceQuspgmn QuspgmlQusled \QUSPDQusopgme QuslpgmeQUSFN12 QusmfillQusopd Quslpd\ QUSFN13 \ QUSERVED11Qusrei Depntname Inzexampleexitpoint DepgmnbrMove \BLANKS Continhdl Callb Qusrei Parm Continhdl Rcvvar RcvvarszFormat Parm Epntname Epntfmt Parm Epgmnbr Qusnbrsc QusecCusrei Begsr DOWExsr Cusrei Enddo Endif Done Remove Exit Program Parm ExitparmsEval Infspcptr = %ADDRRCVVARQUSONE+1 Enddo Endsr Begsr EvalPGM-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 Parm Pgmnbr Qusbn Call QusdrgptQusrepgm DpgmnbrCallb Qusdep Parm Epntname Callb Qusrepgm Parm EpntnameFormat Parm Pgmnbr Qusec API-ILE C ObjectAppendix 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 Procedure Division Using USR-PRF, OBJ-TYPE. MAIN-LINE OBJ-TYPE PICCopy Qsylobjp of QSYSINC-QLBLSRC Address of STRING-SPACEPerform DONE, END-IF PROCES2 Perform PROCES2To LST-STATUS, END-IF END-IF, END-IF Else Move Qsylobjp to APINAM, Perform Apierr Move Length of QUS-EC to BYTES-PROVIDED of QUS-ECMove Quscrtus to APINAM, Perform Apierr Move Qusrobjd to APINAM, Perform Apierr106 Move Qusptrus to APINAM, Perform ApierrDisplay Apinam Display EXCEPTION-ID of QUS-EC. Perform Done Write LIST-LINE from END-LIST. Stop RUNInzadopts Qtemp Dspcsize Dlstptr Dspcptr Darr Basedlstptr DIM32767 Drcvvar108 QSYOBJT13QSYOBJA11 QSYOBJT14Lststatus 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 Pointers-Examples CBLERR1 ProgramWithout LoggingERRHDL1 \LIBL Scope PIC ERROR-HANDLER PICPROGRAM-ID. CBLERR1 PRIOR-ERROR-HANDLER of MISC, QUS-EC ERRHDL1 ProgramADD X to Y PROGRAM-ID. ERRHDL1Misc LOG-EXCEPTION-ID PIC MESSAGE-KEY PICPOINT-OF-FAILURE PIC Binary Value PRINT-JOBLOG PICLogging Software Error OPM Move 1 to MSG-OFFSETLIBRARY-NAME Move C to SYS-OPTION. Stop RUNSRC TGT IpsdsExcpid ImiscSwitch FACT1FACT2 FACT1 DIV FACT2 ResultLogging Software Error OPM API without Pointers-ILE API without Pointers-ILE C Example120 Dpsds SDSAppendix B. Original Examples in Additional BLanguages-121 This section includes the examples Reporting Software Error Refer to Reporting Software Error ILECBLERR2 Program ReportingNUMERIC-GROUP PIC ERROR-HANDLERCopy Qusec of QSYSINC-QCBLLESRC Copy Qpdsrvpg of QSYSINC-QCBLLESRC ERRHDL2 ProgramPROGRAM-ID. ERRHDL2 Procedure Division Using CBL-EXCEPTION-ID MESSAGE-LENGTHSYS-OPTION PIC CBL-PGM-NAMESoftware 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 ABCPGMMRM2ABC ABCPGMMRI1ABCABCPGMMRI2ABC Qclsrc ABC134 Appendix B. Original Examples in Additional BLanguages-135 Program for Packaging a Product-ILE Cobol Example QszcrtpdQszpkgpo PROGRAM-ID. Sftwprdex Environment DivisionCopy Qszcrtpd of QSYSINC-QLBLSRC Copy Qszcrtpl of QSYSINC-QLBLSRCCopy Qszpkgpo of QSYSINC-QLBLSRC API-NAME PICNumkey KEY13LEN13 PID13 PICPerform Prdlod Perform CobjdPerform Pkgpo PrddfnCall Qszcrtpd Using PROD-NAME, QSZ-PRD-INF, QSZ-PRD-OPT Move Spaces to Reserved of QSZ-LNG-LODMove Qszcrtpd to API-NAME, Perform Errcod PrdlodMove 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 144 Packaging aRefer To Program For Product-OPM RPG Example on page A-3 fo OriginalDcobji Numkey PID13 KEY12LID12 KEY5 Dapiname Dfirsterr146 Eval Qszamr = \NO Qszridt = \PHONEEval Qszadn = \NODYNNAM Parm Prodname Qszpi QszpoParm Qszll Parm Pubaut QusecExsr Errcod Endif Endsr Eval Qszlt = \CODE Qszlid = \CODEDFT148 Cobjd Begsr Parm QszalParm Qszpe Nbrpe Qszfl 150 Open Qprint Eval Firsterr = Endif Endsr Oqprint BadnewsApiname Qusei \\CTDATA ObjinfoSpace-Examples Space-ILE Cobol ExampleFILE-USED PIC SPACE-INIT PICOverrides PIC System PICFORMAT-1 PIC EXT-ATTR PICCall Qusptrus Using SPACE-NAME, SPACE-POINTER, QUS-EC API-ERROR-FOUNDSET Address of QDB-QDBFH to SPACE-POINTER Display API-NAMETo a User Space-ILE RPG Example 156 Qdbfhupl Qdbfhmxm\NOMAX QdbfwtfiQdbfhfrt FrcratioQdbhmnum QDBRSV11Qdbfvrm \QDBQAAF2 QDBBITS31QDBRSV17 Qdbfhcrt160 QDBRSV23 QdbffiglQdbfmxrl QDBRSV24Fcfo Fifo Lifo QdbfhrlsQDBRSV27 QdbpfofQDBRSV28 Dspcname Dfilename Dfmtname Dfileused Dlibname DspcsizeDspcptr Dformat Doverrides Dsystem INZ\LCL DFORMAT1 INZ\INT Dchgattr NbrattrCall Quscrtus Parm Spcname \BLANKS Extattr Spcsize Parm Spcinit \CHANGE Spcaut Qdbrtvfd SpctextCall Quscusat Parm Libname Spcname Chgattr Qusec Qusbavl Ifgt Movel Quscusat Apinam Exsr Apierr ENDData Queue-Examples Data Queue-ILE Cobol ExampleFIRST-ERROR PIC PROGRAM-ID. Dqueuex Environment DivisionCopy Qcapcmd of QSYSINC-QLBLSRC CrtlibMSG-BACK PIC WAIT-TIMEMSG PIC Display MSG-BACK ERROR-FOUNDMove 1 to FIRST-ERROR Data Queue-OPM RPG Example 170 Exsr Exccmd Moveldltlib CmdstrExsr Exccmd Seton Retrn QcabcData 172Eval Qcamk = \BLANKS Qcaerved = \LOVAL Eval Cmdstr = Crtlib Lenstr = %SIZECRTLIB Exsr ExeccmdEval Cmdstr = Crtdq Lenstr = %SIZECRTDQ Exsr Execcmd Parm Exampleq174 UNIX-Type APIs-Examples Theread176System API Programming V4R1 Appendix B. Original Examples in Additional BLanguages-177 Using the Integrated File System-ILE Cobol Example PROGRAM-ID. IFS Environment Division PRT-TEXT PICUser PIC Curdir PRT-TEXT PICProcedure DIVISION. MAIN-LINE Open Output Listing TestfileValue LOW-VALUE Oflag PICPerform ERROR-FOUND To LIST-LINE Write LIST-LINEGiving RETURN-INT If RETURN-INTWrite LIST-LINE. Stop RUN To LIST-LINE Perform ERROR-FOUNDTo LIST-LINE Perform ERROR-FOUND Else ERROR-FOUND Write LIST-LINE Fqsysprt184System API Programming V4R1 BLanguages-185 186 Appendix B. Original Examples in Additional BLanguages-187 Oqsysprt Bibliography BooksBooks Bibliography H-3 4System API Programming V4R1 Numerics IndexAPI 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 How satisfied Please tell us how we can improve this manualTo return this form Other countries+1+507+253-5192Reader Comments-Wed Like to Hear from You SC41-5800-00Page IBM IBM