Programming Interface Information, Trademarks | IBM Version 4

Programming Interface Information

This publication is intended to help experienced programmers create application programs. tion documents General-Use Programming Interface and Associated Guidance Information provi Operating System/400 (OS/400) licensed program.

General-Use programming interfaces allow the		customer to write programs	that	obtain	the
OS/400 program. If	you have a requirement	for additional interfaces to	the	OS/400	progr
at 1-507-253-1055 (FAX	507-253-1571).

Trademarks

The following terms are trademarks of			the IBM Corporation in the United States or othe
Advanced	Function Printing		Operating			System/2
Advanced	Peer-to-Peer	Networking	Operating			System/400
AFP			Operational			Assistant
Application	System/400		OS/400
APPN			PrintManager
AS/400			RPG	IV
C/400			RPG/400
COBOL/400			SAA
DB2			SOM
FORTRAN/400			SOMobjects
GDDM			System/38
IBM			System/370
Integrated Language		Environment	Systems		Application		Architecture
NetView			Ultimedia
OfficeVision			400
Microsoft, Windows, and the Windows 95			logo	are	trademarks		or registered trademarks of
poration.

PC Direct is a trademark of Ziff Communications Company and is used by IBM Corporation

UNIX is a registered trademark in the United States and other countries licensed e X/Open Company Limited.

C-bus is a trademark of Corollary, Inc.

Java and HotJava are trademarks of Sun Microsystems, Inc.

Other company, product, and service names, which may be denoted by a double asteris trademarks or service marks of others.

xii System API Programming V4R1

Image 14

IBM Version 4 manual Programming Interface Information, Trademarks

Contents

IBM Page IBM First 1997 Contents RPG ChapterHold 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 Prerequisite UseXiii HLL Xiv 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 Through Functions System APIs or CL Commands-When UseAPIs Cobol ILE RPG Besides the OS/400 APIs that are Related InformationEnvironments OS/400 APIs Are documented Following books Socket Network Functions This StartedLocating the API to Unix Verb Selecting the High-Level Language To Use Language Selection Considerations Data Types API Environments Related Information APIs for the Integrated Language EnvironmentEnvironment CEE APIs for the ILE Common Integrated Language Environment ILE CEE APIs APIs for the Unix EnvironmentAPI Parameters Parameter List Parameter PassingValue of the data object is placed directl Langua Error Code Parameter Parameter Classification With Exception Data-Example Receiving Error Conditions as Exceptions-ExampleError Code Errors From Getting Started with2-11APIs Security Uses Internal IdentifiersSpooling Space User SpacesUser Spaces Used by User Space Format-Example Xxxx Logic Flow of Processing a List of Entries +NO Manipulating a User Using Offset Values with PointersWith Synchronizing between Two or More Jobs Lengths Manipulating a User Space without PointersPosition Values 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 Listing ListUser Additional Information about Beginning Receiver VariablesBytes Returned Fields A receiver variable or the beginning of a Keyed Interface Qusljob API Continuation Handle Using a Continuation HandleUser Space Alternative 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 User Index Considerations APIs and the Qusrtool LibraryUser Index Considerations InSystthem API Reference, SC41-5801 System 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 That Locks Description of an APIParameters Authorities Are described in Required Parameter Group Are Based Objects ThatPerforms Object For Format You Can See fromDecthedecimal Offset Column Can Place Format Name Pass Literal Because the field is a binaryWould Make Binary Value This Name Field Descriptions Error MessagesFormat Optional Parameter Group Perspective ExampleHold Parameter Only Possible values For Hold Job Queue Field Are APIs-Examples Call Jobdapi Parmqbatch \LIBL Handling Error Conditions-OPM RPG ExampleCall Jobdapi Parmqbatch Qgpl 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 Retrieve job description data structure Error-code data structureFollowing data structures are used 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 Job Description Information API-ExampleProcessing Parameters JOBD0100 Format CHAR8 End Severity BytesBytes Returned Job ReplyJob date 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 Ccsid Error HandlingError Handling through the Error Code Parameter 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 Qsylobjp API Other Fields of Generic HeaderOn page 5-14 and the OBJP0200 Format on 5-14. This 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 Iqusky QusbnfQusbng Quskyf Begsr \ENTRY Plist ParmExsr Init Exsr Proces Exsr Done Call Qsylobjp Parm Spctyp Parm RjobdfParm Spcnam Qusbnc Sizent ADD Qusbpq StrposPROC2 QSYB6 ADD Qusbpl Strpos Nument Exsr PROC2Qusbpj Ifeq Movelqusrtvusapinam Exsr Apierr Endif Doueqc Endif USRSPC=P/C EndsrBegsr Movelqusbpj Lststs Oreq Exsr PROC1 Authorities and Locks Required Parameter Group User name OBJP0100OBJP0200 Object type User Space Variables Section Input Field DescriptionsAttribute User Object Type Not Valid Service Program Library &2 ended. Reason codContinuation handle not valid for User space &4 in &9 damaged OPM Error ConditionsParameters Ffdc This Program Calls Log Software Error QpdlogerPointers Without Pointers-ILE Output None Exceptions Unexpectedhdlr Function Ffdc Input \HANDLE 6System API Programming V4R1 \ Unexpectedhdlr \ Software Error ILEAPI with Pointers-ILE C Example QCLE/H Function 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 Discussing Cpynv ITS2ARG2 Result Compiling a Program MI01 Program-Complete Code Example Using Clcrtpg to Create Rexx Testing MI01 Creating the MI Example Program SAV ProgramDebugging the MI Program RST Directive allows users Are Compilers HLLs. BreakBRK Language Statement Such Handling 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 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 Understanding the Micrtpg Program by CodeDeclaring the Structure Following, however, are new statements Usrspc Declaring PointersUsrspcobj Calling Understanding the MICRTPG2 Program by Sections of CodeCreating the Micrtpg Program Enhanced Version Establish addressability to the Crts template Instruction stream, create the space Qcmdexc API BinoffsetOvrdbf DCL Spcptr CLDLTLNG@ Initcldltlng DCL DD Cldltcmd CHAR12 Initdltovr MisrcDCL Spcptr CLOVRLNG@ Initclovrlng CLOVRLNG@ ARG Storage 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 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 PGM PARM&BUFFER &OFFSET Dclf Filemisrc DCL Updated CL06 ProgramFollowing is the updated CL06 program 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 DCL Spcptr SEPT@ Defpco MI Common Programming Techniques-ExamplesEntry \ EXT DCL Sysptr QTEMP@ Defpco DCL DD Sreceiver CHAR8 BDRY16 DCL DD Sbytprv DCL DD Matctxopts CHAR44 DCL DD MatctxctlPOS DCL DD Sbytavl DCL DD Lentry DCL DD LextattrDeflreceiver DCL DD Objentry LRECEIVER@, Sbytavl SRECEIVER@, QTEMP@, MatctxoptsCmpnvb SBYTAVL, 96 / Eqdone 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 Debugger APIs Configuration APIsReturns a list of configuration descriptions, based on a OptiConnect APIs Dynamic Screen Manager APIs Low-level servicesWindow services Debugger File APIs Session servicesEdit Function APIs An edit Code Qdls Hierarchical File SystemHardware Resource APIs Cobol APIs ILE CEE APIs Journal APIs Journal and Commit APIsMessage Handling APIs Commitment Control APIs National Language Support APIs National Language Support APIsNetwork Management APIs Data SNA/Management Services Transport SNA/MS Transport APIs Alert APIs Filter Object APIsNode List API Change Request Management APIs Following describes Clear Data Queue Qclrdtaq Retrieve DescriptionLifo Usridx User Index APIs8APIs-13 Object APIs Chglibl Allows you to rename and mov Office APIsMovobj Conversion Exit Programs Which Are Discussed Under Office MSF File Server APIsOffice Exit Programs Print APIs Performance Collector APIsPrint APIs Most Functions Problem Management APIs Filtering Problem Log Entry APIs Program and CL Command APIsWorking with a Problem Error Reporting APIs Security APIs Software Product APIs Getenv UNIX-Type APIsEnvironment Variable APIs Has Exec Function Integrated File System APIsInterprocess Communication APIs Queues Semaphore Signal APIsAn X/Open Specification As a mechanism by which a process Are identifie Signal Action IDa MIB Sockets APIs Server Client UIM Advantages User Interface APIsProcess-Related APIs UIM Work Management APIs DDS AdvantagesWork Support List APIs Miscellaneous APIsMiscellaneous APIs Process Qgyoljbl API Find Field Numbers List Using the error code Programming errors and refers you toThat show you how to avoid Errors Task Xxxxxxx Using the Error Code ParameterIncorrect Is shown at .2/locationinthe incorrect and correct coding Parm SIZ Intval Parm \ALL Using the Error Code Parameter-Example of Correct CodingCall Quscrtus Parm Spcnam Csetonlr Parm Extattrextatr 1ð Length is Defined Through Defining Data StructuresIncorrect Coding Length Through This Jobid \ SET UP to Accept Exceptions ADD\ZEROSJobnbr Jstat Coding 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 RPG ADD1 Start Qusbn \ Call the API to List the Active Jobs QusljobQusbn \ Retrieve the Offset 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 Recvr ADD Start END \ Delete the Space That Held the Data CodingMovelqusdd Recvr 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 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 \ALL ADD1 Count Addqusbpq Strpos Qusbpj Ifeq C Oreq PQusbps 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 Qussrl QusuaQussgh Qusfn Dqsyobjph Basedlstptr QSYPgmr Change Description QSYOBJT12 Lststatus Doueq Proces BegsrMove Qusis Qusis Ifeq Oreq END Else Qusis IfeqEval Lstptr = %ADDRARRQUSOIP + Exsr Done END Robjdfmt Parm Spcname \USRSPC Objtype Qusec Eval Qusbprv = %SIZEQUSECCall Qusrobjd Parm Rcvvar Rcvvarsiz 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 Eval Lstptr = Addrarrqusoip + QSYOBJT12 Ifeq \SRVPGMEval Lstptr = Addrarrqussee + END Ifeq \BLANKS Move Objtype Parm Call Qsylobjp Parm SpcnameMbrlist Parm \CURRENT Usrprf Parm Qusec Parm \USER Spcdomain RPG Example on page A-3 Packaging Your Own Software ProductsSoftware products CL Program for Packaging aObject Description Dltlib ABC Crtcmd 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 Phone Prddfn Begsr Exsr CobjdExsr Pkgpo Qszbcb Parm Qszbd MovelqszcrtpdapiParm Qszbc Parm Qszbf Qszbj Movelqszcrtplapi Call QszcrtplQszbh Qszbk Cobji CobjdMove OBJ,I Objds Name CAT ABC Pkgpo Parm \YES Repkg MOVEL\ALL QszbrfMovelqszpkgpoapi Call Qszpkgpo Parm Qszbr 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 Example on For the original Original Program Model OPM APIs-ExamplesHold Parameter Exception Message-ILE C Jobdapi Appendix Original Examples in Additional Message-ILE Cobol Identification Division PROGRAM-ID. Jobdapi Environment Division Procedure Division Using JOBD, JOBDL. .8/ MAIN-LINECobol 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 Drcvlen DcmdstringINZ Tousrqpgmr Dformat Handling Error Jobd CAT Jobdlib Lfnam Exsr ErrorError Begsr 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 Dlenstr INZ%SIZECMDSTRING DLENSTR2 INZ%SIZECMDSTR2 DCMDSTR2Msgid INZ Tousrqpgmr 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 Record is LIST-LINE Data Division File SectionLabel Records are Standard LIST-LINE BAD Open Output Listing Move EXCEPTION-ID to Msgid Refer To Accessing Attribute-OPM RPG Example On page 3-17 f Original Oqprint Good Except Good ElseExcept BAD END 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 BYTES-RETURNED JOB-SWITCHES PICDEVICE-RECOVERY-ACTION PIC 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 Qwdun QwdjdnQwdjdln Qwdjd Qwdjmqms QwdordQwdlrd Qwdjmqfa Qwdoill ADD Qwdnlill Eval Using Keys with ListExsr Error Else 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 Filler PIC Using Keys with List Spooled Files API-ILE Cobol ExamplePrtfil PIC Pages Hdrerr TEXT2 PIC Opndat PICLsterr TEXT1 PIC Misc SPC-NAME PIC KEY-INFO Procedure DIVISION. MAIN-LINECall Qusptrus Using SPC-NAME, SPCPTR, QUS-EC STRING-SPACEOFFSET-LIST-DATA SETSTRING-SPACE Spcptr SET Perform Proces Inzspcname Qtemp Dspcsize Using Keys with List Spooled Files API-ILE RPG ExampleTo Opndat Dlstptr DLSTPTR2 Dspcptr Appendix B. Original Examples in Additional BLanguages-43 \QUSERVED34 DqussplkiBASEDLSTPTR2 \ QUSERVED35 Call Quslspl Parm Spcname Parm \BLANKS SpctextParm Qusec \USER Format Parm \CURRENT Usrprf Filnam Begsr AGE CAS Error ENDEval LSTPTR2 = %ADDRARRX END Except Prtlin Move \BLANKS Prtfil Eval Cobol Example APIs-ExamplesExit Integrated BAD-ADD TEXT1 PIC BAD-REG TEXT1 PICEXCEPTION-ID PIC VAR-OFFSET Move 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-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 Ivarrec Printer \ Compile Time Array RECCopy QSYSINC/QRPGSRC,QUS I\ Iovrlay ADD4 ADD2ADD3 Binary ADD Moveabinc REC,OF Exsr Calcvo ADD8 Call Qusaddep REC,OF ExsrADD37 Binary Moveabinc REC,OF Exsr Qusbnc Ifgt Open Printer OFLIND\INOF Usropn ErreptErrpgm Copy QSYSINC/QRPGLESRC,QUS Dvoffset Dvarrec NbrrecsRecs Doverlays Binary Format Parm Varrec Qusec CallbParm Epntname Open Qprint Except Erraepnt Exsr Done Endif Information-OPM Cobol BAD-CREATE TEXT1 PROGRAM-ID. REGFAC2 Environment DivisionEXCEPTION-ID Misc EXIT-POINT-NAME PIC BASE-POINTER Pointer INFO-POINTER SPACE-NAME PIC FORMAT-NAME-1 PICFORMAT-NAME-2 PIC Value Rcvvar Qtemp SPACE-ATTR PIC Call Qusptrus Using SPACE-NAME, BASE-POINTER, QUS-EC Move Spaces to CONTINUATION-HDL To CONTINUATION-HDL Else Stop RUNPerform CALL-EXIT-PROGRAMS CALL-EXIT-PROGRAMS Perform CALL-PGMS Write LIST-LINE from BAD-EXIT-PGM, Stop RUNTo Address of RCVVAROFFSET-PROGRAM-ENTRY 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 Move \BLANKS Copy QSYSINC/QRPGSRC,QUSREGIrcv Call Qusrtvei Parm Conthd RCV Rcvsz Qusccb Parm EpntnmParm Epgmnb SUBSTRCV1 ADD Quscjf Substrcvy Parm RCV RcvszQuscj Quscjg Qusbnd Oqprint Information-ILE RPG ExampleDone Begsr Seton Retrn Endsr Oqprint \ Based Quspplib DquspeQusppn Qusppf Dqusse QusmlibQusmi Qusco Qusad QusmepQusnbrep Qusacc Quspgmn QusoneQusce Quspgml Qusopgme Qusled\QUSPD Quslpgme Qusopd QUSFN12Qusmfill Quslpd Qusrei \ QUSFN13\ QUSERVED11 Depntname Inzexampleexitpoint Depgmnbr Format Parm Epntname Move \BLANKS ContinhdlCallb Qusrei Parm Continhdl Rcvvar Rcvvarsz Epntfmt Parm Epgmnbr Qusnbrsc Qusec Cusrei Begsr DOWExsr Cusrei Enddo Endif Done Eval Infspcptr = %ADDRRCVVARQUSONE+1 Enddo Endsr Remove Exit ProgramParm Exitparms 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 Copy Qsylobjp of QSYSINC-QLBLSRC Procedure Division Using USR-PRF, OBJ-TYPE. MAIN-LINEOBJ-TYPE PIC Address of STRING-SPACE Perform 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 Apierr Display Apinam Display EXCEPTION-ID of QUS-EC. Perform Done 106Move Qusptrus to APINAM, Perform Apierr Write LIST-LINE from END-LIST. Stop RUN Inzadopts Qtemp Dspcsize Dlstptr Dspcptr Darr Basedlstptr DIM32767 Drcvvar QSYOBJA11 108QSYOBJT13 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 Without Pointers-ExamplesCBLERR1 Program Logging ERRHDL1 \LIBL Scope PIC ERROR-HANDLER PICPROGRAM-ID. CBLERR1 ADD X to Y PRIOR-ERROR-HANDLER of MISC, QUS-ECERRHDL1 Program PROGRAM-ID. ERRHDL1 POINT-OF-FAILURE PIC Misc LOG-EXCEPTION-ID PICMESSAGE-KEY PIC Binary Value PRINT-JOBLOG PIC LIBRARY-NAME Logging Software Error OPMMove 1 to MSG-OFFSET Move C to SYS-OPTION. Stop RUN Excpid SRC TGTIpsds Imisc FACT2 SwitchFACT1 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 CBLERR2 Program This section includes the examples Reporting Software ErrorRefer to Reporting Software Error ILE Reporting NUMERIC-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-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 ABCPGMMRI2ABC ABCPGMMRM2ABCABCPGMMRI1ABC Qclsrc ABC 134 Appendix B. Original Examples in Additional BLanguages-135 Qszpkgpo Program for Packaging a Product-ILE Cobol ExampleQszcrtpd PROGRAM-ID. Sftwprdex Environment Division Copy Qszpkgpo of QSYSINC-QLBLSRC Copy Qszcrtpd of QSYSINC-QLBLSRCCopy Qszcrtpl of QSYSINC-QLBLSRC API-NAME PIC LEN13 NumkeyKEY13 PID13 PIC Perform Pkgpo Perform PrdlodPerform Cobjd Prddfn Move Qszcrtpd to API-NAME, Perform Errcod Call Qszcrtpd Using PROD-NAME, QSZ-PRD-INF, QSZ-PRD-OPTMove Spaces to Reserved of QSZ-LNG-LOD 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 Refer To Program For 144Packaging a Product-OPM RPG Example on page A-3 fo Original LID12 KEY5 Dcobji NumkeyPID13 KEY12 Dapiname Dfirsterr Eval Qszadn = \NODYNNAM 146Eval Qszamr = \NO Qszridt = \PHONE Parm Prodname Qszpi Qszpo Exsr Errcod Endif Endsr Parm QszllParm Pubaut Qusec Eval Qszlt = \CODE Qszlid = \CODEDFT 148 Cobjd Begsr Parm QszalParm Qszpe Nbrpe Qszfl 150 Apiname Open Qprint Eval Firsterr = EndifEndsr Oqprint Badnews Qusei \\CTDATA Objinfo FILE-USED PIC Space-ExamplesSpace-ILE Cobol Example SPACE-INIT PIC FORMAT-1 PIC Overrides PICSystem PIC EXT-ATTR PIC SET Address of QDB-QDBFH to SPACE-POINTER Call Qusptrus Using SPACE-NAME, SPACE-POINTER, QUS-ECAPI-ERROR-FOUND Display API-NAME To a User Space-ILE RPG Example 156 \NOMAX QdbfhuplQdbfhmxm Qdbfwtfi Qdbhmnum QdbfhfrtFrcratio QDBRSV11 QDBRSV17 Qdbfvrm\QDBQAAF2 QDBBITS31 Qdbfhcrt 160 Qdbfmxrl QDBRSV23Qdbffigl QDBRSV24 QDBRSV27 Fcfo Fifo LifoQdbfhrls Qdbpfof Dspcptr Dformat Doverrides QDBRSV28Dspcname Dfilename Dfmtname Dfileused Dlibname Dspcsize Dsystem INZ\LCL DFORMAT1 INZ\INT Dchgattr Nbrattr Call 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 END Data Queue-Examples Data Queue-ILE Cobol Example Copy Qcapcmd of QSYSINC-QLBLSRC FIRST-ERROR PICPROGRAM-ID. Dqueuex Environment Division Crtlib MSG-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 Qcabc Data 172 Eval Cmdstr = Crtdq Lenstr = %SIZECRTDQ Exsr Execcmd Eval Qcamk = \BLANKS Qcaerved = \LOVALEval Cmdstr = Crtlib Lenstr = %SIZECRTLIB 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 User PIC PROGRAM-ID. IFS Environment DivisionPRT-TEXT PIC Curdir PRT-TEXT PIC Value LOW-VALUE Procedure DIVISION. MAIN-LINE Open Output ListingTestfile Oflag PIC Giving RETURN-INT Perform ERROR-FOUNDTo LIST-LINE Write LIST-LINE 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 To return this form How satisfiedPlease tell us how we can improve this manual Other countries+1+507+253-5192 Reader Comments-Wed Like to Hear from You SC41-5800-00Page IBM IBM