IBM Systems - Iseries
Total Page:16
File Type:pdf, Size:1020Kb
IBM Systems - iSeries i5/OS PASE APIs Version 5 Release 4 IBM Systems - iSeries i5/OS PASE APIs Version 5 Release 4 Note Before using this information and the product it supports, be sure to read the information in “Notices,” on page 85. Sixth Edition (February 2006) This edition applies to version 5, release 4, modification 0 of IBM i5/OS (product number 5722-SS1) and to all subsequent releases and modifications until otherwise indicated in new editions. This version does not run on all reduced instruction set computer (RISC) models nor does it run on CISC models. © Copyright International Business Machines Corporation 1998, 2006. All rights reserved. US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. Contents i5/OS PASE APIs . .1 Parameters . .16 APIs . .1 Authorities . .16 i5/OS PASE Callable Program APIs . .1 Return Value . .16 QP2SHELL() and QP2SHELL2()—Run an i5/OS Related Information . .16 PASE Shell Program . .2 Qp2free()—Free i5/OS PASE Heap Memory . .16 Parameters . .2 Parameters . .16 Authorities . .2 Authorities . .16 Return Value . .3 Return Value . .16 Error Messages . .3 Related Information . .16 Usage Notes . .3 Qp2jobCCSID()—Retrieve Job CCSID for i5/OS Related Information . .5 PASE . .17 QP2TERM()—Run an i5/OS PASE Terminal Session .5 Parameters . .17 Parameters . .5 Authorities . .17 Authorities . .5 Return Value . .17 Return Value . .5 Related Information . .17 Error Messages . .6 Qp2malloc()—Allocate i5/OS PASE Heap Memory 17 Usage Notes . .6 Parameters . .18 Related Information . .6 Authorities . .18 i5/OS PASE ILE Procedure APIs . .6 Return Value . .18 Qp2dlclose()—Close a Dynamically Loaded i5/OS Related Information . .18 PASE Module . .7 Qp2paseCCSID()—Retrieve i5/OS PASE CCSID . .18 Parameters . .7 Parameters . .19 Authorities . .7 Authorities . .19 Return Value . .8 Return Value . .19 Related Information . .8 Related Information . .19 Qp2CallPase()—Call an i5/OS PASE Procedure . .8 Qp2ptrsize()—Retrieve i5/OS PASE Pointer Size . .19 Parameters . .8 Parameters . .19 Authorities . .10 Authorities . .19 Return Value . .10 Return Value . .19 Usage Notes . .10 Related Information . .19 Related Information . .11 Qp2RunPase()—Run an i5/OS PASE Program . .20 Qp2dlerror()—Retrieve i5/OS PASE Dynamic Load Parameters . .20 Error Information . .11 Authorities . .21 Parameters . .11 Return Value . .21 Authorities . .11 Error Messages . .21 Return Value . .12 Usage Notes . .22 Usage Notes . .12 Related Information . .23 Related Information . .12 Qp2SignalPase()—Post an i5/OS PASE Signal . .24 Qp2dlopen()—Dynamically Load an i5/OS PASE Parameters . .24 Module . .12 Authorities . .24 Parameters . .12 Return Value . .24 Authorities . .13 Usage Notes . .24 Return Value . .13 Related Information . .25 Related Information . .13 Runtime Functions For Use by i5/OS PASE Qp2dlsym()—Find an Exported i5/OS PASE Symbol 14 Programs . .25 Parameters . .14 build_ILEarglist()—Build an ILE Argument List for Authorities . .14 i5/OS PASE . .27 Return Value . .14 Parameters . .27 Related Information . .14 Authorities . .28 Qp2EndPase()—End an i5/OS PASE Program . .15 Return Value . .28 Parameters . .15 Usage Notes . .28 Authorities . .15 Related Information . .28 Return Value . .15 fork400()and f_fork400()—Create A New Process Usage Notes . .15 with i5/OS PASE Options . .28 Related Information . .15 Parameters . .29 Qp2errnop()—Retrieve i5/OS PASE errno Pointer .15 Authorities . .29 © Copyright IBM Corp. 1998, 2006 iii Return Value . .29 Authorities . .41 Error Conditions . .29 Return Value . .41 Usage Notes . .30 Error Conditions . .41 Related Information . .30 Usage Notes . .42 _ILEKILL()—Send ILE Signal for i5/OS PASE . .30 systemCL()—Run a CL Command for i5/OS PASE 42 Parameters . .30 Parameters . .42 Authorities . .30 Authorities . .43 Return Value . .31 Return Value . .43 Error Conditions . .31 Usage Notes . .43 Related Information . .31 _CVTERRNO()—Convert ILE errno to i5/OS PASE _OPEN_CCSID()—Open With CCSID for i5/OS errno . .44 PASE . .31 Parameters . .44 Parameters . .31 Authorities . .44 Authorities . .31 Return Value . .45 Return Value . .32 Usage Notes . .45 Error Conditions . .32 Related Information . .45 Usage Notes . .32 _CVTSPP()—Convert Space Pointer for i5/OS PASE 45 Related Information . .32 Parameters . .45 QMHRCVM()—Receive Nonprogram Message for Authorities . .45 i5/OS PASE . .32 Return Value . .45 Parameters . .33 Error Conditions . .45 Authorities . .33 Usage Notes . .46 Return Value . .33 Related Information . .46 Related Information . .33 _CVTTS64()—Convert Teraspace Address for i5/OS QMHRCVPM()—Receive Program Message for PASE . .46 i5/OS PASE . .33 Parameters . .46 Parameters . .34 Authorities . .46 Authorities . .35 Return Value . .46 Return Value . .35 Error Conditions . .46 Usage Notes . .35 Usage Notes . .46 Related Information . .35 Related Information . .47 QMHSNDM()—Send Nonprogram Message for _GETTS64() and _GETTS64_SPP()—Get Teraspace i5/OS PASE . .35 Address for i5/OS PASE . .47 Parameters . .36 Parameters . .47 Authorities . .36 Authorities . .47 Return Value . .36 Return Value . .47 Related Information . .36 Error Conditions . .47 QMHSNDPM()—Send Program Message for i5/OS Usage Notes . .48 PASE . .37 Related Information . .48 Parameters . .37 _GETTS64M()—Get Multiple Teraspace Pointers for Authorities . .38 i5/OS PASE . .48 Return Value . .38 Parameters . .48 Usage Notes . .38 Authorities . .48 Related Information . .38 Return Value . .48 Qp2setenv_ile()—Set ILE environment variables for Error Conditions . .49 i5/OS PASE . .38 Usage Notes . .49 Parameters . .39 Related Information . .49 Authorities . .39 _ILECALLX()—Call an ILE Procedure for i5/OS Return Value . .39 PASE . .49 Error Conditions. .39 Parameters . .50 Usage Notes . .39 Authorities . .52 Related Information . .40 Return Value . .52 size_ILEarglist()—Compute ILE Argument List Size Usage Notes . .52 for i5/OS PASE . .40 Related Information . .52 Parameters . .40 _ILELOADX()—Load an ILE Bound Program for Authorities . .41 i5/OS PASE . .53 Return Value . .41 Parameters . .53 Related Information . .41 Authorities . .54 SQLOverrideCCSID400()—Override SQL CLI CCSID Return Value . .54 for i5/OS PASE . .41 Error Conditions . .54 Parameters . .41 Related Information . .54 iv IBM Systems - iSeries: i5/OS PASE APIs _ILESYMX()—Find an Exported ILE Symbol for Parameters . .64 i5/OS PASE . .54 Authorities . .64 Parameters . .55 Return Value . .64 Authorities . .55 Error Conditions . .64 Return Value . .55 Usage Notes . .64 Error Conditions. .55 Related Information . .65 Related Information . .56 _SETSPPM()—Set Multiple Space Pointers for i5/OS _MEMCPY_WT()—Copy Memory With Tags for PASE . .65 i5/OS PASE . .56 Parameters . .65 Parameters . .56 Authorities . .65 Authorities . .57 Return Value . .66 Return Value . .57 Error Conditions . .66 Error Conditions. .57 Usage Notes . .66 Usage Notes . .57 Related Information . .66 Related Information . .57 _STRLEN_SPP()—Determine Character String _PGMCALL()—Call an i5/OS Program for i5/OS Length for i5/OS PASE . .66 PASE . .57 Parameters ..