Manuals / IBM / TV and Video / Universal Remote

IBM Version 4 manual 22System API Programming V4R1

Models: Version 4

1 505

Download 505 pages 30.92 Kb

Page 278

A-22System API Programming V4R1

Image 278

IBM Version 4 manual 22System API Programming V4R1

Contents

IBM Page IBM First 1997Contents RPG ChapterHold 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 TrademarksPrerequisite UseXiii HLLXiv System API Programming V4R1 Exit programs That are documented Systemin API CompatibilityAPI Compatibility Because Using APIs-BenefitsSaved Overhead Processing When You Call You Not Have To go ThroughFunctions System APIs or CL Commands-When UseAPIs Cobol ILE RPGBesides the OS/400 APIs that are Related InformationEnvironments OS/400 APIs Are documented Following booksSocket Network Functions This StartedLocating the API to UnixVerb Selecting the High-Level Language To Use Language Selection Considerations Data TypesAPI Environments Related Information APIs for the Integrated Language EnvironmentEnvironment CEE APIs for the ILE CommonIntegrated Language Environment ILE CEE APIs APIs for the Unix EnvironmentAPI Parameters Parameter List Parameter PassingValue of the data object is placed directl LanguaError Code Parameter Parameter ClassificationWith Exception Data-Example Receiving Error Conditions as Exceptions-ExampleError CodeErrors FromGetting Started with2-11APIs Security Uses Internal IdentifiersSpooling Space User SpacesUser Spaces Used byUser Space Format-Example XxxxLogic Flow of Processing a List of Entries +NOManipulating a User Using Offset Values with PointersWith Synchronizing between Two or More JobsLengths Manipulating a User Space without PointersPosition Values 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 RPGListing ListUser Additional Information aboutBeginning Receiver VariablesBytes Returned Fields A receiver variable or the beginning of aKeyed Interface Qusljob APIContinuation Handle Using a Continuation HandleUser Space Alternative Qlicobjd APIMore information Domain ConceptsAPI Exit Points Security, Qalwusrdmn Set to System configured forsystemC2Exit Programs APIs and the Qsysinc LibraryInclude File CcsidCompile Program Specific User Index Considerations APIs and the Qusrtool LibraryUser Index Considerations InSystthem API Reference, SC41-5801System Performance ConsiderationsPerformance Considerations 32System API Programming V4R1 Job Held Queue InformationOriginal Program Model OPM API-Scenario First Step Finding the correct API is to Identify Part ThatLocks Description of an APIParameters AuthoritiesAre described in Required Parameter Group Are Based Objects ThatPerforms Object For Format You Can See fromDecthedecimal Offset ColumnCan Place Format Name Pass Literal Because the field is a binaryWould Make Binary Value This NameField Descriptions Error MessagesFormat Optional Parameter GroupPerspective ExampleHold Parameter Only Possible values For Hold Job Queue Field AreAPIs-Examples Call Jobdapi Parmqbatch \LIBL Handling Error Conditions-OPM RPG ExampleCall Jobdapi Parmqbatch Qgpl 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 Retrieve job description data structure Error-code data structureFollowing data structures are used 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 QusptrusJob Description Information API-ExampleProcessing ParametersJOBD0100 Format CHAR8 End Severity BytesBytes Returned Job ReplyJob date 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 FieldCcsid Error HandlingError Handling through the Error Code Parameter 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 StructureQsylobjp API Other Fields of Generic HeaderOn page 5-14 and the OBJP0200 Format on 5-14. This 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 Iqusky QusbnfQusbng QuskyfBegsr \ENTRY Plist ParmExsr Init Exsr Proces Exsr Done Call QsylobjpParm Spctyp Parm RjobdfParm Spcnam QusbncSizent ADD Qusbpq StrposPROC2 QSYB6ADD Qusbpl Strpos Nument Exsr PROC2Qusbpj Ifeq Movelqusrtvusapinam Exsr Apierr EndifDoueqc Endif USRSPC=P/C EndsrBegsr Movelqusbpj Lststs Oreq Exsr PROC1Authorities and Locks Required Parameter GroupUser name OBJP0100OBJP0200 Object typeUser Space Variables SectionInput Field DescriptionsAttribute UserObject Type Not Valid Service Program Library &2 ended. Reason codContinuation handle not valid for User space &4 in &9 damagedOPM Error ConditionsParameters Ffdc This Program Calls Log Software Error QpdlogerPointers Without Pointers-ILEOutput None Exceptions Unexpectedhdlr Function Ffdc Input\HANDLE 6System API Programming V4R1 \ Unexpectedhdlr \ Software Error ILEAPI with Pointers-ILE C Example QCLE/HFunction SymptommsgkeywordMSGSYMPTOMLEN \HANDLE Numberofkeys, &ErrorCode 12System API Programming V4R1 Machine InterfaceInterface Instructions-Introduction Writing an MI Program-Example Setting the Entry PointSetting the Declare Statements Section DiscussingCpynv ITS2ARG2 ResultCompiling a Program MI01 Program-Complete Code ExampleUsing Clcrtpg to Create RexxTesting MI01 Creating the MI Example ProgramSAV ProgramDebugging the MI Program RSTDirective allows users Are Compilers HLLs. BreakBRK Language Statement SuchHandling Exceptions in the MI Program Excid String 1202 Where 0C12 =andX 02 02= .X While mostFollowing is an updated view of the MI01 program 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 followsUnderstanding the Micrtpg Program by CodeDeclaring the Structure Following, however, are new statementsUsrspc Declaring PointersUsrspcobj Calling Understanding the MICRTPG2 Program by Sections of CodeCreating the Micrtpg Program Enhanced VersionEstablish addressability to the Crts template Instruction stream, create the spaceQcmdexc API BinoffsetOvrdbf DCL Spcptr CLDLTLNG@ Initcldltlng DCL DD Cldltcmd CHAR12 Initdltovr MisrcDCL Spcptr CLOVRLNG@ Initclovrlng CLOVRLNG@ ARGStorage Beginning the Instruction StreamTo Your Advantage Call the Qprcrtpg API to create the MI program MICRTPG2 Complete Program-MI Code ExampleDelete the previous Ovrdbf 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 PGM PARM&BUFFER &OFFSET Dclf Filemisrc DCL Updated CL06 ProgramFollowing is the updated CL06 program 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 RetexcpdDCL Spcptr SEPT@ Defpco MI Common Programming Techniques-ExamplesEntry \ EXT DCL Sysptr QTEMP@ DefpcoDCL DD Sreceiver CHAR8 BDRY16 DCL DD Sbytprv DCL DD Matctxopts CHAR44 DCL DD MatctxctlPOS DCL DD SbytavlDCL DD Lentry DCL DD LextattrDeflreceiver DCL DD ObjentryLRECEIVER@, Sbytavl SRECEIVER@, QTEMP@, MatctxoptsCmpnvb SBYTAVL, 96 / Eqdone 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 Debugger APIs Configuration APIsReturns a list of configuration descriptions, based on a OptiConnect APIsDynamic Screen Manager APIs Low-level servicesWindow services DebuggerFile APIs Session servicesEdit Function APIs An edit CodeQdls Hierarchical File SystemHardware Resource APIs Cobol APIs ILE CEE APIsJournal APIs Journal and Commit APIsMessage Handling APIs Commitment Control APIsNational Language Support APIs National Language Support APIsNetwork Management APIs DataSNA/Management Services Transport SNA/MS Transport APIs Alert APIsFilter Object APIsNode List API Change Request Management APIsFollowing describes Clear Data Queue Qclrdtaq Retrieve DescriptionLifo Usridx User Index APIs8APIs-13 Object APIs ChgliblAllows you to rename and mov Office APIsMovobj Conversion Exit Programs Which Are Discussed Under OfficeMSF File Server APIsOffice Exit Programs Print APIs Performance Collector APIsPrint APIs Most FunctionsProblem Management APIs FilteringProblem Log Entry APIs Program and CL Command APIsWorking with a Problem Error Reporting APIsSecurity APIs Software Product APIsGetenv UNIX-Type APIsEnvironment Variable APIs Has Exec Function Integrated File System APIsInterprocess Communication APIs QueuesSemaphore Signal APIsAn X/Open Specification As a mechanism by which a process Are identifieSignal ActionIDa MIBSockets APIs Server ClientUIM Advantages User Interface APIsProcess-Related APIs UIMWork Management APIs DDS AdvantagesWork SupportList APIs Miscellaneous APIsMiscellaneous APIs ProcessQgyoljbl API Find Field Numbers ListUsing the error code Programming errors and refers you toThat show you how to avoid Errors TaskXxxxxxx Using the Error Code ParameterIncorrect Is shown at .2/locationinthe incorrect and correct codingParm SIZ Intval Parm \ALL Using the Error Code Parameter-Example of Correct CodingCall Quscrtus Parm Spcnam CsetonlrParm Extattrextatr 1ð Length is Defined Through Defining Data StructuresIncorrect Coding Length Through ThisJobid \ SET UP to Accept Exceptions ADD\ZEROSJobnbr JstatCoding Defining a Data Structure-Example\ Call the API to List the Active Jobs Qusljob Intval \ SET UP to Accept Exceptions ADD\ZEROS\ Create the Space to Hold the Data Call Quscrtus List Entry from the Space\ Delete the Space That Held the Data May Written Over with These extra characters. On Call When Defining Receiver VariablesWhen Run Lists All Active Jobs System RPGADD1 Start Qusbn \ Call the API to List the Active Jobs QusljobQusbn \ Retrieve the Offset 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 DowlequsbpsRecvr ADD Start END \ Delete the Space That Held the Data CodingMovelqusdd Recvr 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 Incorrect Using Offsets in a User SpaceUsing Offsets in a User Point For Beginning Read User\FLAG Reason Level Date Pgmr Qgpl Copy QSYSINC/QRPGSRC,QUSLOBJIusersp APIUG1 Iobject \ALLADD1 Count Addqusbpq Strpos Qusbpj Ifeq C Oreq PQusbps 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 Qussrl QusuaQussgh QusfnDqsyobjph Basedlstptr QSYPgmr Change Description QSYOBJT12Lststatus Doueq Proces BegsrMove Qusis Qusis Ifeq OreqEND Else Qusis IfeqEval Lstptr = %ADDRARRQUSOIP + Exsr Done ENDRobjdfmt Parm Spcname \USRSPC Objtype Qusec Eval Qusbprv = %SIZEQUSECCall Qusrobjd Parm Rcvvar Rcvvarsiz Qusei IfeqPGM, or Coding for New Function-Example CorrectDoes Not match 9B ð INZ1 Lupa Basedspcptr46System API Programming V4R1 Else QSYOBJT12 Ifeq Dsply ElseEval Lstptr = Addrarrqusoip + QSYOBJT12 Ifeq \SRVPGMEval Lstptr = Addrarrqussee + END Ifeq \BLANKS MoveObjtype Parm Call Qsylobjp Parm SpcnameMbrlist Parm \CURRENT Usrprf Parm QusecParm \USER Spcdomain RPG Example on page A-3 Packaging Your Own Software ProductsSoftware products CL Program for Packaging aObject Description Dltlib ABCCrtcmd ABC/ABC ABC/ABCPGM ABCDEV/QCMDSRC + Crtdspf ABC/ABCDSPF ABCDEV/QDDSSRC +Crtpf ABC/ABCPF ABCDEV/QDDSSRC + Crtpnlgrp ABC/ABCPNLGRP ABCDEV/QPNLSRC +Copy QSYSINC/QRPGSRC,QSZCRTPD Textd Copy QSYSINC/QRPGSRC,QSZCRTPLCopy QSYSINC/QRPGSRC,QSZPKGPO PhonePrddfn Begsr Exsr CobjdExsr Pkgpo QszbcbParm Qszbd MovelqszcrtpdapiParm Qszbc Parm QszbfQszbj Movelqszcrtplapi Call QszcrtplQszbh QszbkCobji CobjdMove OBJ,I Objds Name CAT ABC PkgpoParm \YES Repkg MOVEL\ALL QszbrfMovelqszpkgpoapi Call Qszpkgpo Parm Qszbr 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 LanguagesExample on For the original Original Program Model OPM APIs-ExamplesHold Parameter Exception Message-ILE C JobdapiAppendix Original Examples in Additional Message-ILE Cobol Identification DivisionPROGRAM-ID. Jobdapi Environment Division Procedure Division Using JOBD, JOBDL. .8/ MAIN-LINECobol Copy Qusec of QSYSINC-QLBLSRCCopy QSYSINC/QRPGLESRC,QUSEC Move Jobd to JOB-DESC. Move Jobdl to JOB-DESC-LIBMove HOLD-JOB-QUEUE to Hold Drcvlen DcmdstringINZ Tousrqpgmr DformatHandling Error Jobd CAT Jobdlib Lfnam Exsr ErrorError Begsr 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,QWDRJOBDDlenstr INZ%SIZECMDSTRING DLENSTR2 INZ%SIZECMDSTR2 DCMDSTR2Msgid INZ Tousrqpgmr Call Qwdrjobd ParmParm LENSTR2 Endsr Accessing the Hold Attribute-ILE C ExampleMovel Qusei Msgid Call Qcmdexc Parm File Hold Attribute-ILE PROGRAM-ID. JobdapiData Record is LIST-LINE Data Division File SectionLabel Records are Standard LIST-LINEBAD Open Output Listing Move EXCEPTION-ID to Msgid Refer To Accessing Attribute-OPM RPG Example On page 3-17 f OriginalOqprint Good Except Good ElseExcept BAD END 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 QwdrjobdBYTES-RETURNED JOB-SWITCHES PICDEVICE-RECOVERY-ACTION PIC BYTES-AVAILABLECall Qcmdexc Using COMMAND-STRING, COMMAND-LENGTH, ADD 11 to Perform NUMBER-LIBS-IN-LIB-LIST TimesList-ILE RPG ReclenQwdbrtn QwdbavlQwdun QwdjdnQwdjdln QwdjdQwdjmqms QwdordQwdlrd QwdjmqfaQwdoill ADD Qwdnlill Eval Using Keys with ListExsr Error Else 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 Filler PIC Using Keys with List Spooled Files API-ILE Cobol ExamplePrtfil PIC PagesHdrerr TEXT2 PIC Opndat PICLsterr TEXT1 PIC Misc SPC-NAME PICKEY-INFO Procedure DIVISION. MAIN-LINECall Qusptrus Using SPC-NAME, SPCPTR, QUS-EC STRING-SPACEOFFSET-LIST-DATA SETSTRING-SPACE Spcptr SET Perform ProcesInzspcname Qtemp Dspcsize Using Keys with List Spooled Files API-ILE RPG ExampleTo Opndat Dlstptr DLSTPTR2 DspcptrAppendix B. Original Examples in Additional BLanguages-43 \QUSERVED34 DqussplkiBASEDLSTPTR2 \ QUSERVED35Call Quslspl Parm Spcname Parm \BLANKS SpctextParm Qusec \USER Format Parm \CURRENT UsrprfFilnam Begsr AGE CAS Error ENDEval LSTPTR2 = %ADDRARRX END Except Prtlin Move \BLANKS Prtfil EvalCobol Example APIs-ExamplesExit IntegratedBAD-ADD TEXT1 PIC BAD-REG TEXT1 PICEXCEPTION-ID PIC VAR-OFFSETMove Exit Point Example Move 2 to NBR-RECORDSMove 3 to CONTROL-KEY of QUS-VLEN-REC-4 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 Ivarrec Printer \ Compile Time Array RECCopy QSYSINC/QRPGSRC,QUS I\ IovrlayADD4 ADD2ADD3 Binary ADD Moveabinc REC,OF Exsr Calcvo ADD8Call Qusaddep REC,OF ExsrADD37 Binary Moveabinc REC,OF Exsr Qusbnc Ifgt OpenPrinter OFLIND\INOF Usropn ErreptErrpgm Copy QSYSINC/QRPGLESRC,QUSDvoffset Dvarrec NbrrecsRecs Doverlays BinaryFormat Parm Varrec Qusec CallbParm Epntname Open Qprint Except Erraepnt Exsr Done EndifInformation-OPM Cobol BAD-CREATE TEXT1 PROGRAM-ID. REGFAC2 Environment DivisionEXCEPTION-ID Misc EXIT-POINT-NAME PICBASE-POINTER Pointer INFO-POINTER SPACE-NAME PIC FORMAT-NAME-1 PICFORMAT-NAME-2 PIC Value Rcvvar Qtemp SPACE-ATTR PICCall Qusptrus Using SPACE-NAME, BASE-POINTER, QUS-EC Move Spaces to CONTINUATION-HDLTo CONTINUATION-HDL Else Stop RUNPerform CALL-EXIT-PROGRAMS CALL-EXIT-PROGRAMSPerform CALL-PGMS Write LIST-LINE from BAD-EXIT-PGM, Stop RUNTo Address of RCVVAROFFSET-PROGRAM-ENTRY 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 Move \BLANKS Copy QSYSINC/QRPGSRC,QUSREGIrcv Call Qusrtvei Parm Conthd RCV RcvszQusccb Parm EpntnmParm Epgmnb SUBSTRCV1ADD Quscjf Substrcvy Parm RCV RcvszQuscj QuscjgQusbnd Oqprint Information-ILE RPG ExampleDone Begsr Seton Retrn Endsr Oqprint \ BasedQuspplib DquspeQusppn QusppfDqusse QusmlibQusmi QuscoQusad QusmepQusnbrep QusaccQuspgmn QusoneQusce QuspgmlQusopgme Qusled\QUSPD QuslpgmeQusopd QUSFN12Qusmfill QuslpdQusrei \ QUSFN13\ QUSERVED11 Depntname Inzexampleexitpoint DepgmnbrFormat Parm Epntname Move \BLANKS ContinhdlCallb Qusrei Parm Continhdl Rcvvar Rcvvarsz Epntfmt Parm Epgmnbr Qusnbrsc QusecCusrei Begsr DOWExsr Cusrei Enddo Endif Done Eval Infspcptr = %ADDRRCVVARQUSONE+1 Enddo Endsr Remove Exit ProgramParm Exitparms 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 Copy Qsylobjp of QSYSINC-QLBLSRC Procedure Division Using USR-PRF, OBJ-TYPE. MAIN-LINEOBJ-TYPE PIC Address of STRING-SPACEPerform DONE, END-IF PROCES2 Perform PROCES2To LST-STATUS, END-IF END-IF, END-IF Else Move Quscrtus to APINAM, Perform Apierr Move Qsylobjp to APINAM, Perform ApierrMove Length of QUS-EC to BYTES-PROVIDED of QUS-EC Move Qusrobjd to APINAM, Perform ApierrDisplay Apinam Display EXCEPTION-ID of QUS-EC. Perform Done 106Move Qusptrus to APINAM, Perform Apierr Write LIST-LINE from END-LIST. Stop RUNInzadopts Qtemp Dspcsize Dlstptr Dspcptr Darr Basedlstptr DIM32767 DrcvvarQSYOBJA11 108QSYOBJT13 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 Without Pointers-ExamplesCBLERR1 Program LoggingERRHDL1 \LIBL Scope PIC ERROR-HANDLER PICPROGRAM-ID. CBLERR1 ADD X to Y PRIOR-ERROR-HANDLER of MISC, QUS-ECERRHDL1 Program PROGRAM-ID. ERRHDL1POINT-OF-FAILURE PIC Misc LOG-EXCEPTION-ID PICMESSAGE-KEY PIC Binary Value PRINT-JOBLOG PICLIBRARY-NAME Logging Software Error OPMMove 1 to MSG-OFFSET Move C to SYS-OPTION. Stop RUNExcpid SRC TGTIpsds ImiscFACT2 SwitchFACT1 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 CBLERR2 Program This section includes the examples Reporting Software ErrorRefer to Reporting Software Error ILE ReportingNUMERIC-GROUP PIC ERROR-HANDLERCopy Qusec of QSYSINC-QCBLLESRC Copy Qpdsrvpg of QSYSINC-QCBLLESRC ERRHDL2 ProgramPROGRAM-ID. ERRHDL2 SYS-OPTION PIC Procedure Division Using CBL-EXCEPTION-IDMESSAGE-LENGTH 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 ABCPGMMRI2ABC ABCPGMMRM2ABCABCPGMMRI1ABC Qclsrc ABC134 Appendix B. Original Examples in Additional BLanguages-135 Qszpkgpo Program for Packaging a Product-ILE Cobol ExampleQszcrtpd PROGRAM-ID. Sftwprdex Environment DivisionCopy Qszpkgpo of QSYSINC-QLBLSRC Copy Qszcrtpd of QSYSINC-QLBLSRCCopy Qszcrtpl of QSYSINC-QLBLSRC API-NAME PICLEN13 NumkeyKEY13 PID13 PICPerform Pkgpo Perform PrdlodPerform Cobjd PrddfnMove Qszcrtpd to API-NAME, Perform Errcod Call Qszcrtpd Using PROD-NAME, QSZ-PRD-INF, QSZ-PRD-OPTMove Spaces to Reserved of QSZ-LNG-LOD 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 Refer To Program For 144Packaging a Product-OPM RPG Example on page A-3 fo OriginalLID12 KEY5 Dcobji NumkeyPID13 KEY12 Dapiname DfirsterrEval Qszadn = \NODYNNAM 146Eval Qszamr = \NO Qszridt = \PHONE Parm Prodname Qszpi QszpoExsr Errcod Endif Endsr Parm QszllParm Pubaut Qusec Eval Qszlt = \CODE Qszlid = \CODEDFT148 Cobjd Begsr Parm QszalParm Qszpe Nbrpe Qszfl 150 Apiname Open Qprint Eval Firsterr = EndifEndsr Oqprint Badnews Qusei \\CTDATA ObjinfoFILE-USED PIC Space-ExamplesSpace-ILE Cobol Example SPACE-INIT PICFORMAT-1 PIC Overrides PICSystem PIC EXT-ATTR PICSET Address of QDB-QDBFH to SPACE-POINTER Call Qusptrus Using SPACE-NAME, SPACE-POINTER, QUS-ECAPI-ERROR-FOUND Display API-NAMETo a User Space-ILE RPG Example 156 \NOMAX QdbfhuplQdbfhmxm QdbfwtfiQdbhmnum QdbfhfrtFrcratio QDBRSV11QDBRSV17 Qdbfvrm\QDBQAAF2 QDBBITS31 Qdbfhcrt160 Qdbfmxrl QDBRSV23Qdbffigl QDBRSV24QDBRSV27 Fcfo Fifo LifoQdbfhrls QdbpfofDspcptr Dformat Doverrides QDBRSV28Dspcname Dfilename Dfmtname Dfileused Dlibname Dspcsize Dsystem INZ\LCL DFORMAT1 INZ\INT Dchgattr NbrattrCall Quscusat Parm Libname Spcname Chgattr Qusec Call Quscrtus Parm Spcname \BLANKS ExtattrSpcsize Parm Spcinit \CHANGE Spcaut Qdbrtvfd Spctext Qusbavl Ifgt Movel Quscusat Apinam Exsr Apierr ENDData Queue-Examples Data Queue-ILE Cobol ExampleCopy Qcapcmd of QSYSINC-QLBLSRC FIRST-ERROR PICPROGRAM-ID. Dqueuex Environment Division CrtlibMSG-BACK PIC WAIT-TIMEMSG PIC Display MSG-BACK ERROR-FOUNDMove 1 to FIRST-ERROR Data Queue-OPM RPG Example 170 Exsr Exccmd Seton Retrn Exsr ExccmdMoveldltlib Cmdstr QcabcData 172Eval Cmdstr = Crtdq Lenstr = %SIZECRTDQ Exsr Execcmd Eval Qcamk = \BLANKS Qcaerved = \LOVALEval Cmdstr = Crtlib Lenstr = %SIZECRTLIB 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 User PIC PROGRAM-ID. IFS Environment DivisionPRT-TEXT PIC Curdir PRT-TEXT PICValue LOW-VALUE Procedure DIVISION. MAIN-LINE Open Output ListingTestfile Oflag PICGiving RETURN-INT Perform ERROR-FOUNDTo LIST-LINE Write LIST-LINE 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 To return this form How satisfiedPlease tell us how we can improve this manual Other countries+1+507+253-5192Reader Comments-Wed Like to Hear from You SC41-5800-00Page IBM IBM