Related Information, Environments | IBM Version 4 manual

Ÿ Defining,	creating,	distributing,	and	maintaining	your own software prod
See “Packaging Your Own Software Products” on					page A-1	for an example
packaging	a product	similar to	the	way IBM	packages	products.

ŸControlling systems and networks, which can include configuration, spooled

files,		network management,		problem		management,	and so	forth.
Ÿ Handling		objects, which		includes		creating,	changing,	copying, deleting,
and	renaming		objects on	the	system.
APIs can		also	be categorized		by	the operating environment. For more inf
refer	to	“API	Environments”	on page 2-4.

Related Information

Besides the OS/400 APIs that are					documentedSystem inAPItheReference, other
OS/400 APIs			are documented in the		following books:
Ÿ	Common	Programming		APIs Toolkit/400 Reference, SC41-4802
Ÿ	CPI Communications Reference, SC26-4399
Ÿ	DB2	for	AS/400	Query Management	Programming, SC41-5703
Ÿ	GDDM Programming Guide, SC41-0536
Ÿ	Machine Interface Functional Reference, SC41-5810
Ÿ	PrintManager API			Reference, S544-3699

ŸREXX/400 Programmer’s Guide, SC41-5728, and REXX/400 Reference, SC41-5729

ŸUltimedia System Facilities Programming, SC41-4652

Many products on the AS/400 system also provide APIs. Refer to the pro umentation for more information.

ŸClient Access

Ÿ OfficeVision for AS/400

ŸOSI File Services, OSI Message Services, and OSI Communications Sub- system

Ÿ System Manager for AS/400 and Managed System Services for OS/400

ŸTCP/IP Connectivity Utilities for AS/400

1-4System API Programming V4R1

Image 20

IBM Version 4 manual Related Information, Environments, Besides the OS/400 APIs that are

Contents

IBM Page IBM First 1997 Contents Chapter HoldRPG Across APIs ProgrammingMICRTPG2 OPM Cobol Index ViiOPM API Viii System API Programming V4R1 Micrtpg System API Programming V4R1 Disclaimed IBMImplied Warranties of Merchantability and Fitness for Programming Interface Information Trademarks Use XiiiPrerequisite HLL Xiv 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 Through System APIs or CL Commands-When Use APIsFunctions Cobol ILE RPG Related Information EnvironmentsBesides the OS/400 APIs that are OS/400 APIs Are documented Following books Started Locating the API toSocket Network Functions This Unix Verb Selecting the High-Level Language To Use Language Selection Considerations Data Types API Environments APIs for the Integrated Language Environment Environment CEERelated Information APIs for the ILE Common Integrated Language Environment ILE CEE APIs APIs for the Unix EnvironmentAPI Parameters Parameter Passing Value of the data object is placed directlParameter List Langua Error Code Parameter Parameter Classification Receiving Error Conditions as Exceptions-Example ErrorWith Exception Data-Example Code Errors From Getting Started with2-11APIs Security Uses Internal IdentifiersSpooling User Spaces User SpacesSpace Used by User Space Format-Example Xxxx Logic Flow of Processing a List of Entries +NO Using Offset Values with Pointers WithManipulating a User Synchronizing between Two or More Jobs Manipulating a User Space without Pointers Position ValuesLengths Space APIs Quschgus API Following is a user space after you change it with one Changing a User Space with an ILE RPG Program-Example \ Program Changusptr Changing a User Space with an OPM RPG Program-Example RPG List UserListing Additional Information about Receiver Variables Bytes Returned FieldsBeginning A receiver variable or the beginning of a Keyed Interface Qusljob API Using a Continuation Handle User Space AlternativeContinuation Handle Qlicobjd API More information Domain ConceptsAPI Exit Points Security, Qalwusrdmn Set to System configured forsystemC2Exit Programs APIs and the Qsysinc Library Include File CcsidCompile Program Specific APIs and the Qusrtool Library User Index ConsiderationsUser Index Considerations InSystthem API Reference, SC41-5801 System 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 That Description of an API ParametersLocks Authorities Are Based Objects That Performs Object ForAre described in Required Parameter Group Format You Can See fromDecthedecimal Offset Column Because the field is a binary Would Make Binary ValueCan Place Format Name Pass Literal This Name Error Messages FormatField Descriptions Optional Parameter Group Example Hold ParameterPerspective Only Possible values For Hold Job Queue Field Are APIs-Examples Handling Error Conditions-OPM RPG Example Call Jobdapi Parmqbatch QgplCall Jobdapi Parmqbatch \LIBL Call Jobdapi Parmxyz \LIBL Ipgmsts SDS Msgidd OPM RPG ITOUSRQPGMR36 47 MSG3B Error Parameter Format Error code structure Qusbn is Error Code Structure Can Found Common 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 Description Code 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 Structure Initial 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 Qusptrus API-Example ProcessingJob Description Information Parameters JOBD0100 Format CHAR8 End Severity BytesBytes Returned Reply Job dateJob Library YES MSG 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 Exit Program Attribute Keys Key Type Field Error Handling Error Handling through the Error Code ParameterCcsid Initialize Bytes provided Field Number Parameter Second Exception handling is by having All Exceptions Signa Receiver Variables-Examples Entry With Fields-Example ILE C Registration Facility Using ILE APIs-ExamplesAdd Exit Program-ILE Description \EXCLUDE API Exit Point Example 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 Remove Exit Program and Deregister Exit Point-ILE C Example Language ILE C Description 20System API Programming V4R1 Errorcode.ecfields.ExceptionId Exit1 \ End program \ 22System API Programming V4R1 Characteristics of a List General Data Structure Offset to List Data Section General Data Structure Other Fields of Generic Header On page 5-14 and the OBJP0200 Format on 5-14. ThisQsylobjp 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 Qusbnf QusbngIqusky Quskyf \ENTRY Plist Parm Exsr Init Exsr Proces Exsr DoneBegsr Call Qsylobjp Parm Rjobdf Parm SpcnamParm Spctyp Qusbnc ADD Qusbpq Strpos PROC2Sizent QSYB6 Nument Exsr PROC2 Qusbpj IfeqADD Qusbpl Strpos Movelqusrtvusapinam Exsr Apierr Endif Endif USRSPC=P/C Endsr Begsr Movelqusbpj LststsDoueqc Oreq Exsr PROC1 Authorities and Locks Required Parameter Group OBJP0100 OBJP0200User name Object type User Space Variables Section Field Descriptions AttributeInput User Service Program Library &2 ended. Reason cod Continuation handle not valid forObject Type Not Valid User space &4 in &9 damaged OPM Error ConditionsParameters This Program Calls Log Software Error Qpdloger PointersFfdc Without Pointers-ILE Output None Exceptions Unexpectedhdlr Function Ffdc Input \HANDLE 6System API Programming V4R1 Software Error ILE API with Pointers-ILE C Example\ Unexpectedhdlr \ QCLE/H Function 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 Discussing ITS2 ARG2Cpynv Result Compiling a Program MI01 Program-Complete Code Example Using Clcrtpg to Create Rexx Testing MI01 Creating the MI Example Program Program Debugging the MI ProgramSAV RST Are Compilers HLLs. Break BRKDirective allows users Language Statement Such Handling 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 id Creating an MI Version of Clcrtpg Qprcrtpg .API Program Flow for Creating the Micrtpg Program Source for CL03 follows Source for CL04 follows Source for CL05 follows Source for the Micrtpg Program Source for Micrtpg follows Code Declaring the StructureUnderstanding the Micrtpg Program by Following, however, are new statements Usrspc Declaring PointersUsrspcobj Understanding the MICRTPG2 Program by Sections of Code Creating the Micrtpg ProgramCalling Enhanced Version Establish addressability to the Crts template Instruction stream, create the space Qcmdexc API BinoffsetOvrdbf DCL DD Cldltcmd CHAR12 Initdltovr Misrc DCL Spcptr CLOVRLNG@ InitclovrlngDCL Spcptr CLDLTLNG@ Initcldltlng CLOVRLNG@ ARG Storage 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 done DCL 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 Rcvf Qtemp Creating the MICRTPG2Handling Exceptions Example Its Consolidated State This Is the new MICRTPG2 program Machine Interface Programming7-29 CTXQSYS, Typepgm INT Retexcpd MI Common Programming Techniques-Examples Entry \ EXTDCL Spcptr SEPT@ Defpco DCL Sysptr QTEMP@ Defpco DCL DD Matctxopts CHAR44 DCL DD Matctxctl POSDCL DD Sreceiver CHAR8 BDRY16 DCL DD Sbytprv DCL DD Sbytavl DCL DD Lextattr DeflreceiverDCL DD Lentry DCL DD Objentry SRECEIVER@, QTEMP@, Matctxopts Cmpnvb SBYTAVL, 96 / EqdoneLRECEIVER@, Sbytavl Cpynv LBYTPRV, Sbytavl API before Developing Your Cations AS/400 Program StorageProcess Allo Cating Initializing automatic Storage Backup Recovery APIs Provides Way to That Is only provided Service ProgramCommunications APIs Configuration APIs Returns a list of configuration descriptions, based on aDebugger APIs OptiConnect APIs Low-level services Window servicesDynamic Screen Manager APIs Debugger Session services Edit Function APIsFile APIs An edit Code Qdls Hierarchical File SystemHardware Resource APIs Cobol APIs ILE CEE APIs Journal and Commit APIs Message Handling APIsJournal APIs Commitment Control APIs National Language Support APIs Network Management APIsNational Language Support APIs Data SNA/Management Services Transport SNA/MS Transport APIs Alert APIs Object APIs Node List APIFilter Change Request Management APIs Following describes Clear Data Queue Qclrdtaq Retrieve DescriptionLifo Usridx User Index APIs8APIs-13 Object APIs Chglibl Office APIs MovobjAllows you to rename and mov Conversion Exit Programs Which Are Discussed Under Office MSF File Server APIsOffice Exit Programs Performance Collector APIs Print APIsPrint APIs Most Functions Problem Management APIs Filtering Program and CL Command APIs Working with a ProblemProblem Log Entry APIs Error Reporting APIs Security APIs Software Product APIs Getenv UNIX-Type APIsEnvironment Variable APIs Integrated File System APIs Interprocess Communication APIsHas Exec Function Queues Signal APIs An X/Open Specification As a mechanism by which a processSemaphore Are identifie Signal Action IDa MIB Sockets APIs Server Client User Interface APIs Process-Related APIsUIM Advantages UIM DDS Advantages WorkWork Management APIs Support Miscellaneous APIs Miscellaneous APIsList APIs Process Qgyoljbl API Find Field Numbers List Programming errors and refers you to That show you how to avoid ErrorsUsing the error code Task Using the Error Code Parameter IncorrectXxxxxxx Is shown at .2/locationinthe incorrect and correct coding Using the Error Code Parameter-Example of Correct Coding Call Quscrtus Parm SpcnamParm SIZ Intval Parm \ALL Csetonlr Parm Extattrextatr 1ð Defining Data Structures Incorrect CodingLength is Defined Through Length Through This \ SET UP to Accept Exceptions ADD\ZEROS JobnbrJobid Jstat Coding Defining a Data Structure-Example 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 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 RPG Qusbn \ Call the API to List the Active Jobs Qusljob Qusbn \ Retrieve the OffsetADD1 Start Qusbn \ Retrieve the List Entries Qusbpq ADD Start Qusgen \\ JOB Name Structure for Calling Qusljob Ijobnam \ALL Qusbn \ 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 Dowlequsbps Coding Movelqusdd RecvrRecvr 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 Byte Correct Byte Alignment ensures that data used With an QusVlenRec4t descrec Char Desc5ð Addepattributes This is a Test Exit PROGRAM,27 Defining Byte Alignment-Example Correct ILE C EXAMPLEPGMEXAMPLELIB, 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 \ALL Qusbpj Ifeq C Oreq P QusbpsADD1 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 Oreq Qusbpq ADD Strpos Exsr Errcod Seton Retrn Coding for New Function For \FLAG Reason Dspcname Inzadopts Qtemp DspcsizeDspcinit Qusua QussghQussrl Qusfn QSY Pgmr Change DescriptionDqsyobjph Basedlstptr QSYOBJT12 Proces Begsr Move QusisLststatus Doueq Qusis Ifeq Oreq Qusis Ifeq Eval Lstptr = %ADDRARRQUSOIP +END Else Exsr Done END Eval Qusbprv = %SIZEQUSEC Call Qusrobjd Parm Rcvvar RcvvarsizRobjdfmt Parm Spcname \USRSPC Objtype Qusec Qusei Ifeq PGM, or Coding for New Function-Example CorrectDoes Not match 9B ð INZ1 Lupa Basedspcptr 46System API Programming V4R1 Else QSYOBJT12 Ifeq Dsply Else QSYOBJT12 Ifeq \SRVPGM Eval Lstptr = Addrarrqussee + ENDEval Lstptr = Addrarrqusoip + Ifeq \BLANKS Move Call Qsylobjp Parm Spcname Mbrlist Parm \CURRENT UsrprfObjtype Parm Parm Qusec Parm \USER Spcdomain RPG Example on page A-3 Packaging Your Own Software ProductsSoftware products Packaging a Object DescriptionCL Program for Dltlib ABC Crtdspf 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 Phone Exsr Cobjd Exsr PkgpoPrddfn Begsr Qszbcb Movelqszcrtpdapi Parm QszbcParm Qszbd Parm Qszbf Movelqszcrtplapi Call Qszcrtpl QszbhQszbj Qszbk Cobjd Move OBJ,I Objds Name CAT ABCCobji Pkgpo MOVEL\ALL Qszbrf Movelqszpkgpoapi Call Qszpkgpo Parm QszbrParm \YES Repkg Parm \NO Retriev Command B-129Qszrtvpr API Rtvfd \CHANGE \LCL \INT 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 Appendix Additional Languages Original Program Model OPM APIs-Examples Hold Parameter Exception Message-ILE CExample on For the original Jobdapi Appendix Original Examples in Additional Message-ILE Cobol Identification Division Procedure Division Using JOBD, JOBDL. .8/ MAIN-LINE CobolPROGRAM-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 Dcmdstring INZ TousrqpgmrDrcvlen Dformat Handling Error Exsr Error Error BegsrJobd 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 Call Qcmdexc Using MESSAGE-TWO, COMMAND-LENGTH, Stop RUN Copy QSYSINC/QRPGLESRC,QWDRJOBD DCMDSTR2 Msgid INZ TousrqpgmrDlenstr INZ%SIZECMDSTRING DLENSTR2 INZ%SIZECMDSTR2 Call Qwdrjobd Parm Parm LENSTR2 Endsr Accessing the Hold Attribute-ILE C ExampleMovel Qusei Msgid Call Qcmdexc Parm File Hold Attribute-ILE PROGRAM-ID. Jobdapi Data Division File Section Label Records are StandardData Record is LIST-LINE LIST-LINE BAD Open Output Listing Move EXCEPTION-ID to Msgid Refer To Accessing Attribute-OPM RPG Example On page 3-17 f Original Except Good Else Except BAD ENDOqprint 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 Roch Value Qwdrjobd JOB-SWITCHES PIC DEVICE-RECOVERY-ACTION PICBYTES-RETURNED BYTES-AVAILABLE Call Qcmdexc Using COMMAND-STRING, COMMAND-LENGTH, ADD 11 to Perform NUMBER-LIBS-IN-LIB-LIST Times List-ILE RPG Reclen Qwdbrtn Qwdbavl Qwdjdn QwdjdlnQwdun Qwdjd Qwdord QwdlrdQwdjmqms Qwdjmqfa Using Keys with List Exsr Error ElseQwdoill 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 Using Keys with List Spooled Files API-ILE Cobol Example Prtfil PICFiller PIC Pages Opndat PIC Lsterr TEXT1 PICHdrerr TEXT2 PIC Misc SPC-NAME PIC KEY-INFO Procedure DIVISION. MAIN-LINECall Qusptrus Using SPC-NAME, SPCPTR, QUS-EC SET STRING-SPACE Spcptr SETSTRING-SPACEOFFSET-LIST-DATA Perform Proces Using Keys with List Spooled Files API-ILE RPG Example To OpndatInzspcname Qtemp Dspcsize Dlstptr DLSTPTR2 Dspcptr Appendix B. Original Examples in Additional BLanguages-43 Dqussplki BASEDLSTPTR2\QUSERVED34 \ QUSERVED35 Parm \BLANKS Spctext Parm Qusec \USERCall Quslspl Parm Spcname Format Parm \CURRENT Usrprf AGE CAS Error END Eval LSTPTR2 = %ADDRARRX END Except PrtlinFilnam Begsr Move \BLANKS Prtfil Eval APIs-Examples ExitCobol Example Integrated BAD-REG TEXT1 PIC EXCEPTION-ID PICBAD-ADD TEXT1 PIC VAR-OFFSET Move 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-4 By Content Length of EXIT-PGM-DATA of MISC, VARREC, QUS-EC Register Exit Point TEXT1 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 Iovrlay ADD2 ADD3ADD4 Binary ADD Moveabinc REC,OF Exsr Calcvo ADD8 REC,OF Exsr ADD37 Binary Moveabinc REC,OF ExsrCall Qusaddep Qusbnc Ifgt Open Errept ErrpgmPrinter OFLIND\INOF Usropn Copy QSYSINC/QRPGLESRC,QUS Dvarrec Nbrrecs RecsDvoffset Doverlays Binary Callb Parm EpntnameFormat Parm Varrec Qusec Open Qprint Except Erraepnt Exsr Done Endif Information-OPM Cobol PROGRAM-ID. REGFAC2 Environment Division EXCEPTION-IDBAD-CREATE TEXT1 Misc EXIT-POINT-NAME PIC FORMAT-NAME-1 PIC FORMAT-NAME-2 PICBASE-POINTER Pointer INFO-POINTER SPACE-NAME PIC Value Rcvvar Qtemp SPACE-ATTR PIC Call Qusptrus Using SPACE-NAME, BASE-POINTER, QUS-EC Move Spaces to CONTINUATION-HDL Else Stop RUN Perform CALL-EXIT-PROGRAMSTo CONTINUATION-HDL CALL-EXIT-PROGRAMS Write LIST-LINE from BAD-EXIT-PGM, Stop RUN To Address of RCVVAROFFSET-PROGRAM-ENTRYPerform 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 Copy QSYSINC/QRPGSRC,QUSREG IrcvMove \BLANKS Call Qusrtvei Parm Conthd RCV Rcvsz Parm Epntnm Parm EpgmnbQusccb SUBSTRCV1 Parm RCV Rcvsz QuscjADD Quscjf Substrcvy Quscjg Information-ILE RPG Example Done Begsr Seton Retrn Endsr OqprintQusbnd Oqprint \ Based Dquspe QusppnQuspplib Qusppf Qusmlib QusmiDqusse Qusco Qusmep QusnbrepQusad Qusacc Qusone QusceQuspgmn Quspgml Qusled \QUSPDQusopgme Quslpgme QUSFN12 QusmfillQusopd Quslpd \ QUSFN13 \ QUSERVED11Qusrei Depntname Inzexampleexitpoint Depgmnbr Move \BLANKS Continhdl Callb Qusrei Parm Continhdl Rcvvar RcvvarszFormat Parm Epntname Epntfmt Parm Epgmnbr Qusnbrsc Qusec Cusrei Begsr DOWExsr Cusrei Enddo Endif Done Remove Exit Program Parm ExitparmsEval 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 Parm Pgmnbr Qusbn Call Qusdrgpt Qusrepgm Dpgmnbr Callb Qusdep Parm Epntname Callb Qusrepgm Parm EpntnameFormat Parm Pgmnbr Qusec API-ILE C Object 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 Procedure Division Using USR-PRF, OBJ-TYPE. MAIN-LINE OBJ-TYPE PICCopy 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 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 Apierr 106 Move Qusptrus to APINAM, Perform ApierrDisplay Apinam Display EXCEPTION-ID of QUS-EC. Perform Done Write LIST-LINE from END-LIST. Stop RUN Inzadopts Qtemp Dspcsize Dlstptr Dspcptr Darr Basedlstptr DIM32767 Drcvvar 108 QSYOBJT13QSYOBJA11 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 Pointers-Examples CBLERR1 ProgramWithout Logging ERRHDL1 \LIBL Scope PIC ERROR-HANDLER PICPROGRAM-ID. CBLERR1 PRIOR-ERROR-HANDLER of MISC, QUS-EC ERRHDL1 ProgramADD X to Y PROGRAM-ID. ERRHDL1 Misc LOG-EXCEPTION-ID PIC MESSAGE-KEY PICPOINT-OF-FAILURE PIC Binary Value PRINT-JOBLOG PIC Logging Software Error OPM Move 1 to MSG-OFFSETLIBRARY-NAME Move C to SYS-OPTION. Stop RUN SRC TGT IpsdsExcpid Imisc Switch FACT1FACT2 FACT1 DIV FACT2 Result Logging Software Error OPM API without Pointers-ILE API without Pointers-ILE C Example 120 Dpsds SDS Appendix B. Original Examples in Additional BLanguages-121 This section includes the examples Reporting Software Error Refer to Reporting Software Error ILECBLERR2 Program Reporting NUMERIC-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-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 ABCPGMMRM2ABC ABCPGMMRI1ABCABCPGMMRI2ABC Qclsrc ABC 134 Appendix B. Original Examples in Additional BLanguages-135 Program for Packaging a Product-ILE Cobol Example QszcrtpdQszpkgpo PROGRAM-ID. Sftwprdex Environment Division Copy Qszcrtpd of QSYSINC-QLBLSRC Copy Qszcrtpl of QSYSINC-QLBLSRCCopy Qszpkgpo of QSYSINC-QLBLSRC API-NAME PIC Numkey KEY13LEN13 PID13 PIC Perform Prdlod Perform CobjdPerform Pkgpo Prddfn Call Qszcrtpd Using PROD-NAME, QSZ-PRD-INF, QSZ-PRD-OPT Move Spaces to Reserved of QSZ-LNG-LODMove 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 144 Packaging aRefer To Program For Product-OPM RPG Example on page A-3 fo Original Dcobji Numkey PID13 KEY12LID12 KEY5 Dapiname Dfirsterr 146 Eval Qszamr = \NO Qszridt = \PHONEEval Qszadn = \NODYNNAM Parm Prodname Qszpi Qszpo Parm Qszll Parm Pubaut QusecExsr Errcod Endif Endsr Eval Qszlt = \CODE Qszlid = \CODEDFT 148 Cobjd Begsr Parm QszalParm Qszpe Nbrpe Qszfl 150 Open Qprint Eval Firsterr = Endif Endsr Oqprint BadnewsApiname Qusei \\CTDATA Objinfo Space-Examples Space-ILE Cobol ExampleFILE-USED PIC SPACE-INIT PIC Overrides PIC System PICFORMAT-1 PIC EXT-ATTR PIC Call Qusptrus Using SPACE-NAME, SPACE-POINTER, QUS-EC API-ERROR-FOUNDSET Address of QDB-QDBFH to SPACE-POINTER Display API-NAME To a User Space-ILE RPG Example 156 Qdbfhupl Qdbfhmxm\NOMAX Qdbfwtfi Qdbfhfrt FrcratioQdbhmnum QDBRSV11 Qdbfvrm \QDBQAAF2 QDBBITS31QDBRSV17 Qdbfhcrt 160 QDBRSV23 QdbffiglQdbfmxrl QDBRSV24 Fcfo Fifo Lifo QdbfhrlsQDBRSV27 Qdbpfof QDBRSV28 Dspcname Dfilename Dfmtname Dfileused Dlibname DspcsizeDspcptr Dformat Doverrides Dsystem INZ\LCL DFORMAT1 INZ\INT Dchgattr Nbrattr Call 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 END Data Queue-Examples Data Queue-ILE Cobol Example FIRST-ERROR PIC PROGRAM-ID. Dqueuex Environment DivisionCopy 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 Exsr Exccmd Moveldltlib CmdstrExsr Exccmd Seton Retrn Qcabc Data 172 Eval Qcamk = \BLANKS Qcaerved = \LOVAL Eval Cmdstr = Crtlib Lenstr = %SIZECRTLIB Exsr ExeccmdEval Cmdstr = Crtdq Lenstr = %SIZECRTDQ Exsr Execcmd Parm Exampleq 174 UNIX-Type APIs-Examples Theread 176System 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 PIC Procedure DIVISION. MAIN-LINE Open Output Listing TestfileValue LOW-VALUE Oflag PIC Perform ERROR-FOUND To LIST-LINE Write LIST-LINEGiving RETURN-INT If RETURN-INT Write LIST-LINE. Stop RUN To LIST-LINE Perform ERROR-FOUNDTo LIST-LINE Perform ERROR-FOUND Else ERROR-FOUND Write LIST-LINE Fqsysprt 184System API Programming V4R1 BLanguages-185 186 Appendix B. Original Examples in Additional BLanguages-187 Oqsysprt Bibliography Books Books Bibliography H-3 4System API Programming V4R1 Numerics Index 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 How satisfied Please tell us how we can improve this manualTo return this form Other countries+1+507+253-5192 Reader Comments-Wed Like to Hear from You SC41-5800-00Page IBM IBM