/IF NOT DEFINED(XTOOLS_API_PROTOS)

/DEFINE XTOOLS_API_PROTOS
** (c) Copyright 2003 by Robert Cozzi, Jr.
**
Based on RPG xTools source code.
**
Permission to use, granted.
**
no other rights granted.
**
specifically, the right to
**
publish in any form is denied.
**
**
YOU MAY NOT MODIFY THIS "HEADER"
**
SECTION IN ANY WAY.
******************************************
** Support this effort by purchasing a *
** license to the RPG xTools.
*
** ----------------------------------- *
** Visit www.RPGxTools.com for details *
******************************************
D
D
D
D
D

QUSEC_Err
us_DSLen
us_nRtnLen
us_CpfMsgID
us_apiResv1t

DS

D
D
D
D
D
D
D
D
D
D

QUSEC_Ex
DS
ex_apiKey
ex_apiLenEx
ex_apiRLenEx
ex_apiMsgIDEx
ex_apiResvdEx
ex_apiCCSID
ex_apiOffExc
ex_apiExcLen
ex_apiExcData

Inz
10I 0 Inz(%size(qusec_Err))
10I 0 Inz(0)
7A
1A
Inz
10I
10I
10I
7A
1A
10I
10I
10I
64A

0
0
0
0
0
0

** List a job's joblog messages into a user space

QMHLJOBL
PR
ExtPgm('QMHLJOBL')
szUserSpace
20A Const
apiFormat
8A Const
msgSelInfo
32766A Const OPTIONS(*VARSIZE)
nMsgSelLen
10I 0 Const
msgSelFmt
8A Const
api_Error
Like(QUSEC_Err)

D
D
D
D
D
D
D

** Open List of Job Log Messages (QGYOLJBL) API

QGYOLJBL
PR
ExtPgm('QGYOLJBL')
szRtnBuffer
65535A OPTIONS(*VARSIZE)
nRtnBufLen
10I 0 Const
szListInfo
80A
nRtnRecCnt
10I 0 Const
msgSelInfo
32766A Const OPTIONS(*VARSIZE)
nMsgSelLen
10I 0 Const
api_Error
Like(QUSEC_Err)

D
D
D
D
D
D
D
D

** Get List Entries (QGYGTLE) API

D QGYGTLE
PR
D szRtnBuffer
65535A

ExtPgm('QGYGTLE')
OPTIONS(*VARSIZE)

D
D
D
D
D
D

nRtnBufLen
hReqHandle
szListInfo
nRtnRecCnt
nStartRecNbr
api_Error

10I 0 Const
4A Const
80A
10I 0 Const
10I 0 Const
Like(QUSEC_Err)

D DbgAttr
D RtnAttr
D api_Error

10A
10A

Const
Like(QUSEC_Err)

D
D
D
D
D
D
D

QzhbCgiParse
szCmd
Format
szRecvBuffer
nLenRecvBuf
nBytesRead
api_error

PR

D
D
D
D

QtmhWrStout
szHtml
nBufLen
api_error

PR

ExtProc('QtmhWrStout')
65535A Const OPTIONS(*VARSIZE)
10I 0 CONST
Like(QUSEC_Err )

D
D
D
D
D

QtmhRdStin
szRtnBuffer
nBufLen
nRtnLen
api_error

PR

ExtProc('QtmhRdStin')
65535A OPTIONS(*VARSIZE)
10I 0 CONST
10I 0
Like(QUSEC_Err )

D
D
D
D
D
D
D
D
D

QtmhCvtDb
fmtFile
urlString
nURLLen
RtnDS
nRtnDSLen
nBytesRtn
nAPIRtnCode
QUSEC

PR

*
8A
65535A
10I 0
10I 0

Like(QUSEC_Err

20A
65535A
10I
65535A
10I
10I
10I

** Retrieve Data Area data

QwcRtvDtaAra
PR
szRtnData
nRtnDataLen
szDataArea
nStartPos
nLength

D
D
D
D
D
D

D QWVRCSTK
D szRtnData
D nRtnVarLen
D Format
D szJobID
D JobFormat
D apiError

ExtProc('QzhbCgiParse')
VALUE OPTIONS(*STRING)
Const
Options(*VARSIZE)
Const

PR

ExtProc('QtmhCvtDb')
Const
Const OPTIONS(*VARSIZE)
0 Const
Options(*VARSIZE)
0 Const
0
0
Like(QUSEC_Err )

ExtPgm('QWCRDTAA')
2000A Options(*VARSIZE)
10I 0 Const
20A Const
10I 0 Const
10I 0 Const
ExtPgm('QWVRCSTK')
65535A OPTIONS(*VARSIZE)
10I 0 Const
8A Const
56A Const
8A Const
Like(QUSEC_Err )

** Library Description KEYS Data structure

D RTK_RLIBKEYS
DS
Inz
D tk_rlibkeycnt
10I 0
D tk_rlibKey
10I 0 Dim(8)

** Retrieve Library Description

QLIRLIBD
PR
ExtPgm('QLIRLIBD')
szLibInfo
256A Options(*VARSIZE)
nLibInfoLen
10I 0 Const
szLibrary
10A Const
Keys
Like(RTK_RLIBKEYS)
apiError
Like(QUSEC_Err )

D
D
D
D
D
D

** Translate using a table

QDCXLATE
PR
ExtPgm('QDCXLATE')
nLength
5P 0 Const
szDataIn
32766A
xlTable
10A Const
xlTableLib
10A Const

D
D
D
D
D

** Retrieve System Value

QWCRSVAL
PR
szSysVal
nSysValLen
nSysValCnt
szSysValues
apiError

D
D
D
D
D
D

ExtPgm('QWCRSVAL')
4096A Options(*VARSIZE)
10I 0 Const
10I 0 Const
100A Const
Like(QUSEC_Err ) Options(*NOPASS)

*********************************************************
** C O N V E R T E D I T C O D E T O E D I T M A S K
*********************************************************
D CvtEditCode
PR
ExtPgm('QECCVTEC')
D EdtMsk
256A
D EdtMskLen
10I 0
D RcvVarLen
10I 0
D ZeroFill
1A
D EditCode
1A CONST
D FillChar
1A CONST
D Digits
10I 0 CONST
D DecPos
10I 0 CONST
D api_error
Like(QUSEC_Err )
*********************************************************
** C O N V E R T E D I T W O R D T O E D I T M A S K
*********************************************************
D CvtEditWord
PR
ExtPgm('QECCVTEW')
D EditMask
256A
D EditMaskLen
10I 0
D RcvVarLen
10I 0
D EditWord
256A CONST
D nEditWordLen
10I 0 CONST
D api_error
Like(QUSEC_Err )
D nDigits
10I 0 Const OPTIONS(*NOPASS)
D szCurSymbol
1A Const OPTIONS(*NOPASS)
*********************************************************
** R E T R I E V E L I B R A R Y L I S T
*********************************************************
D QRTVJOBI
PR
EXTPGM('QUSRJOBI')
D libl
6000A OPTIONS(*VARSIZE)
D nLibl
10I 0 Const
D FmtName
8A Const
D Job
26A Const

D InternJob
D api_error

16A

Const
Like(QUSEC_Err

*********************************************************
** C H A N G E L I B R A R Y L I S T
*********************************************************
D QLICHGLL
PR
EXTPGM('QLICHGLL')
D CurLib
11A Const
D ProdLib1
11A Const
D ProdLib2
11A Const
D UsrLibl
11A Const DIM(250)
D nUsrLiblCount
10I 0 Const
D api_error
Like(QUSEC_Err )
*********************************************************
** C H A N G E U S E R S P A C E A T T R I B U T E S
*********************************************************
D QusChgUsrSpaceAttr...
D
PR
ExtPgm('QUSCUSAT')
D RtnLibName
10A
D UsrSpace
20A Const
D USAttr
64A OPTIONS(*VARSIZE)
D api_error
Like(QUSEC_Err )
*********************************************************
** C R E A T E U S E R S P A C E
*********************************************************
D QusCrtUsrSpace PR
ExtPgm('QUSCRTUS')
D UsrSpace
20A Const
D ExtAttr
10A Const
D nSize
10I 0 Const
D InitValue
1A Const
D PubAuth
10A Const
D szTextDesc
50A Const
D Replace
10A Const
D api_error
Like(QUSEC_Err ) OPTIONS(*NOPASS)
D bSysDomain
10A Const OPTIONS(*NOPASS)
*********************************************************
** C H A N G E U S E R S P A C E D A T A
*********************************************************
D QusChgUsrSpace PR
ExtPgm('QUSCHGUS')
D szUsrSpace
20A Const
D nStart
10I 0 Const
D nLength
10I 0 Const
D szData
65535A Const options(*VARSIZE)
D bForceAux
1A Const
D api_error
Like(QUSEC_Err ) OPTIONS(*NOPASS)
*********************************************************
** R E T R I E V E U S E R S P A C E D A T A
*********************************************************
D QusRtvUsrSpace PR
ExtPgm('QUSRTVUS')
D szUsrSpace
20A Const
D nStart
10I 0 Const
D nLength
10I 0 Const
D szData
65535A Options(*VARSIZE)
D api_error
Like(QUSEC_Err ) OPTIONS(*NOPASS)
**************************************************************

** R E T R I E V E U S E R S P A C E A T T R I B U T E S
**************************************************************
D QusRtvUsrSpaceAttr...
D
PR
ExtPgm('QUSRUSAT')
D szData
64A Options(*VARSIZE)
D nLength
10I 0 Const
D Format
8A Const
D szUsrSpace
20A Const
D api_error
Like(QUSEC_Err ) OPTIONS(*NOPASS)
************************************************************
** R E T R I E V E P O I N T E R T O U S E R S P A C E
************************************************************
D QusRtvPtrToUsrSpace...
D
PR
ExtPgm('QUSPTRUS')
D szUserspace
20A Const
D pRtnPtr
*
D api_error
Like(QUSEC_Err ) OPTIONS(*NOPASS)
*********************************************************
** E N U M E R A T E F I L E F O R M A T
*********************************************************
D EnumFormats
PR
ExtPgm('QUSLRCD')
D UsrSpace
20A Const
D Format
8A Const
D FileName
20A Const
D bOvride
1N Const
D apiError
Like(QUSEC_Err )
*********************************************************
** E N U M E R A T E F I L E F I E L D L I S T
*********************************************************
D EnumFields
PR
ExtPgm('QUSLFLD')
D UsrSpace
20A Const
D Format
8A Const
D FileName
20A Const
D RcdFmt
10A Const
D bOvride
1N Const
D apiError
Like(QUSEC_Err )
*********************************************************
** E N U M E R A T E Database Relations
*********************************************************
D QUSLDBR
PR
ExtPgm('QDBLDBR')
D UsrSpace
20A Const
D Format
8A Const
D FileName
20A Const
D MbrName
10A Const
D FmtName
10A Const
D apiError
Like(QUSEC_Err )
*********************************************************
** E N U M E R A T E Modules for a *PGM
*********************************************************
D EnumPgmMods
PR
ExtPgm('QBNLPGMI')
D UsrSpace
20A Const
D Format
8A Const
D PgmName
20A Const
D apiError
Like(QUSEC_Err )

*********************************************************
** E N U M E R A T E Modules for a *SRVPGM
*********************************************************
D EnumSrvPgmMods PR
ExtPgm('QBNLSPGM')
D UsrSpace
20A Const
D Format
8A Const
D SrvName
20A Const
D apiError
Like(QUSEC_Err )
*********************************************************
** E N U M E R A T E M E M B E R L I S T
*********************************************************
D EnumMbrs
PR
ExtPgm('QUSLMBR')
D UsrSpace
20A Const
D Format
8A Const
D FileName
20A Const
D MbrName
10A Const
D bOvride
1N Const
D apiError
Like(QUSEC_Err )
*********************************************************
** E N U M E R A T E O B J E C T L I S T
*********************************************************
D EnumObjects
PR
ExtPgm('QUSLOBJ')
D UsrSpace
20A Const
D Format
8A Const
D ObjName
20A Const
D ObjType
10A Const
D apiError
Like(QUSEC_Err ) OPTIONS(*NOPASS)
D ObjAut
64A OPTIONS(*VARSIZE: *NOPASS)
D SelOmit
64A OPTIONS(*VARSIZE: *NOPASS)
*********************************************************
** R E T R I E V E O B J E C T D E S C R I P I T I O N
*********************************************************
D QusRtvObjd
PR
ExtPgm('QUSROBJD')
D rtnData
65535A OPTIONS(*VARSIZE)
D nRtnDataLen
10I 0 Const
D Format
8A Const
D QualObj
20A Const
D ObjType
10A Const
D apiError
Like(QUSEC_Err )
*********************************************************
** R E T R I E V E U S E R S P A C E D A T A
*********************************************************
D QusRTVUS
PR
ExtPgm('QUSRTVUS')
D UsrSpace
20A Const
D nStart
10I 0 Const
D nLength
10I 0 Const
D szRtnBuffer
32766A OPTIONS(*VARSIZE)
*********************************************************
** D E L E T E U S E R S P A C E O B J E C T
*********************************************************
D QusDLTUS
PR
ExtPgm('QUSDLTUS')
D UsrSpace
20A Const
D apiError
Like(QUSEC_Err )
*********************************************************

** C O N V E R T C A S E
*********************************************************
D QlgCvtCase
PR
ExtProc('QlgConvertCase')
D ctrlBlock
22A Const
D inString
65535A Const Options(*VARSIZE)
D OutString
65535A Options(*VARSIZE)
D nLength
10I 0 Const
D APIErrorDS
Like(QUSEC_Ex)
**************************************************************
** R E T R I E V E D I S P L A Y F I L E D E S C
**************************************************************
D QdfRTVFD
PR
ExtPgm('QDFRTVFD')
D rtnBuffer
65535A OPTIONS(*VARSIZE)
D nBufLen
10I 0 Const
D szAPIFmt
8A Const
D szFile
20A Const
D api_error
Like(QUSEC_Err ) OPTIONS(*NOPASS)
*********************************************************
** E N U M E R A T E Installed HFS L I S T
*********************************************************
D QHFLSTFS
PR
ExtPgm('QHFLSTFS')
D szUserSpace
20A Const
D szAPIFmt
8A Const
D api_error
Like(QUSEC_Err )
*********************************************************
** E N U M E R A T E J O B S
*********************************************************
D EnumJobs
PR
ExtPgm('QUSLJOB')
D szUserSpace
20A Const
D szAPIFmt
8A Const
D JobID
26A Const
D JobStatus
10A Const
D apiError
Like(QUSEC_Err ) OPTIONS(*NOPASS)
** * - This value lists all job types.
** A - The job is an autostart job.
** B - The job is a batch job.
** I - The job is an interactive job.
** M - The job is a subsystem monitor job.
** R - The job is a spooled reader job.
** S - The job is a system job.
** W - The job is a spooled writer job.
** X - The job is the start-control-program-function (SCPF) system job.
D JobType
1A Const OPTIONS(*NOPASS)
*********************************************************
** E N U M E R A T E List Active Subsystems
*********************************************************
D QWCLASBS
PR
ExtPgm('QWCLASBS')
D szUserSpace
20A Const
D szAPIFmt
8A Const
D api_error
Like(QUSEC_Err )
*********************************************************
** E N U M E R A T E S P O O L F I L E N A M E S L I S T
*********************************************************
D EnumSPLF
PR
ExtPgm('QUSLSPL')
D szUserSpace
20A Const

D
D
D
D
D
D
D
D
D
D

Format
UserName
OutQ
FormType
UserData
apiError
JobID
RtnFldKeys
FldKeyCnt
ASP

8A
10A
20A
10A
10A

Const
Const
Const
Const
Const
Like(QUSEC_Err ) OPTIONS(*NOPASS)
26A Const OPTIONS(*NOPASS)
10I 0 Const OPTIONS(*NOPASS) Dim(24)
10I 0 Const OPTIONS(*NOPASS)
10I 0 Const OPTIONS(*NOPASS)

*********************************************************
** C R E A T E U S E R I N D E X
*********************************************************
D QusCrtUsrIndex PR
ExtPgm('QUSCRTUI')
D UsrIndex
20A Const
D ExtAttr
10A Const
D FixedOrVar
1A Const
D IndexSize
10I 0 Const
D Keyed
1A Const
D KeyLength
10I 0 Const
D ImmedMaint
1A Const
D OptKeyed
1A Const
D PubAuth
10A Const
D Text
50A Const
D Replace
10A Const OPTIONS(*NOPASS)
D api_error
Like(QUSEC_Err ) OPTIONS(*NOPASS)
D QusDltUsrIndex PR
D UsrIndex
D api_error
** List Authorized Users
EnumUsrPrf
PR
szUserSpace
szAPIFmt
api_error

D
D
D
D
D
D
D
D
D
D
D
D
D

EnumActUsers
PR
szUserSpace
Format
UserName
DspDevName
InclInActive
InclUserOutput...
apiError

20A

ExtPgm('QUSDLTUI')
Const
Like(QUSEC_Err )

20A
8A

ExtPgm('QSYLAUTU')
Const
Const
Like(QUSEC_Err )

20A
8A
10A
10A
10A

ExtPgm('QEZLSGNU')
Const
Const
Const
Const
Const

10A

Const
Like(QUSEC_Err

** List Jobs that have an object locked "locked by who"

QWCLOBJL
PR
ExtPgm('QWCLOBJL')
szUserSpace
20A Const
szAPIFmt
8A Const
QualObj
20A Const
ObjType
10A Const
MbrName
10A Const
api_error
Like(QUSEC_Err )

D
D
D
D
D
D
D

D QDBRTVFD
D szRtnBufrer
D nBuffLen

PR

ExtPgm('QDBRTVFD')
32765A OPTIONS(*VARSIZE)
10I 0 Const

D
D
D
D
D
D
D
D

RtnFileName
szAPIFmt
szQualFile
szRcdFmt
bOverride
szRmtLocSys
szIntFileType
api_error

20A
8A
20A
10A
1A
10A
10A

** Convert MI Object type to OS/400

D QLICVTTP
PR
D** CVTFMT Values = '*HEXTOSYM' and
D CVTFMT
10A
D OBJTYPE
10A
D MITYPE
2A
D api_error

Const
Const
Const
Const
Const
Const
Like(QUSEC_Err

Object Type and back again.

ExtPgm('QLICVTTP')
'*SYMTOHEX'
Const
OPTIONS(*VARSIZE)
OPTIONS(*VARSIZE)
Like(QUSEC_Err )

** Retrieve Overrides for a file.

D QDMRTVFO
PR
EXTPGM('QDMRTVFO')
D szOvrBuffer
48A OPTIONS(*VARSIZE)
D nBufLen
10I 0 CONST
*** Use OVRL0100 for the next parameter
D szAPIFmt
8A CONST
D szFileName
10A CONST
D api_error
Like(QUSEC_Err )
** SEND Program Message
QMHSNDPM
PR
szMsgID
szMsgFile
szMsgData
nMsgDataLen

D
D
D
D
D

7A
20A
6000A
10I 0

ExtPgm('QMHSNDPM')
Const
Const
Const Options(*varsize)
Const

**
**
**
**
**
**
**
**
**

Message Type may be one of the following:

*COMP
- Completion
*DIAG
- Diagnostic
*ESCAPE - Escape
*INFO
- Informational
*INQ
- Inquiry. (only when ToPgmQ(*EXT) is specified.
*NOTIFY - Notify
*RQS
- Request
*STATUS - Status
D szMsgType
10A Const
** Call Stack Entry may be one of the following:
** *
- *SAME
** *EXT
- The external message queue
** *CTLBDY - Control Boundary
D szCallStkEntry...
D
10A Const
D nRelativeCallStkEntry...
D
10I 0 Const
D szRtnMsgKey
4A
D api_error
Like(QUSEC_Err )
****************************************
** Retreive Program Information
**
****************************************
D QRTVPGMI
PR
ExtPgm('QCLRPGMI')
D szRecvBuffer
65535A Options(*VARSIZE)
D nLenRecvBuf
10I 0 Const

D FmtName
D pgmname
D api_error
D
D
D
D
D
D
D
D
D

QRtvMbrD
szRecvBuffer
nLenRecvBuf
FmtName
fileName
MbrName
bOvrProc
api_error
bFindMbr
/ENDIF

8A
20A
PR

Const
Const
Like(QUSEC_Err

ExtPgm('QUSRMBRD')
65535A Options(*VARSIZE)
10I 0 Const
8A Const
20A Const
10A Const
1A Const
Like(QUSEC_Err )
1A Const OPTIONS(*NOPASS)