The iSeries-toolkit: Open Source toolkit for the AS/400 programmer (Module X-Reference)

The modules in the iSeries-toolkit use quite a few APIs. The modules are also packaged into various service programs and programs. The following table catalogs most of the APIs called by the iSeries-toolkit. If you are looking for examples of a particular API, this is the place to start.

The following table describes the various APIs employed by the iSeries-toolkit and identifies their associated module and service program:

Module	Service Program	API	Description
CHGOBJD	CHGOBJD	QLICOBJD	Change Object Description
CVTNUMFMT	NUMTKT	_LBCPYNV	Late Bound Copy Numeric Value
CVTNUMFMT	NUMTKT	_LBCPYNVR	Late Bound Copy Numeric Value with Rounding
DTAQ	DTAQ	QCLRDTAQ	Clear Data Queue
		QMHRDQM	Retrieve Data Queue Message
		QRCVDTAQ	Receive Data Queue Entry
		QSNDDTAQ	Send Data Queue Entry
EDTVAR	NUMTKT	QECCVTEC	Convert Edit Code to Edit Mask
		QECCVTEW	Convert Edit Word to Edit Mask
		QECEDT	Apply Edit Mask
ENVVAR	JOBTKT	getenv	Get Environment Variable
ENVVAR	JOBTKT	putenv	Put Environment Variable
EXCCMD	EXCCMD	QCMDEXC	Execute CL Command
LSTDBR	FILTKT	QDBLDBR	Retrieve Database Relations
LSTMBR	FILTKT	QUSLMBR	List File Member Information to a User Space
LSTMOD	PGMTKT	QBNLMODI	List Module Information to a User Space
LSTOBJ	OBJTKT	QUSLOBJ	List Object Information to a User Space
LSTPGM	PGMTKT	QBNLPGMI	List Program Information to a User Space
LSTSRVPGM	PGMTKT	QBNLSPGM	List Service Program Information to a User Space
MSGDTKT	MSGDTKT	QMHRMFAT	Retrieve Message File Attributes
MSGTKT	MSGTKT	QMHRTVM	Retrieve Program Message
		QMHMOVPM	Move Program Messages
		QMHRCVPM	Receive Program Message
		QMHRMVPM	Remove Program Message
		QMHRTVRQ	Retrieve Request Message
		QMHSNDPM	Send Program Message
OBJ	OBJTKT	QLICVTTP	Get Object Type as Hex Value
OBJ	OBJTKT	rslvsp	Resolve Space Pointer
OBJLST	OBJTKT	QGYOLOBJ	List Objects
OPNLST	OPNLST	QGYCLST	Close List
OPNLST	OPNLST	QGYGTLE	Get List Entry
RTVFD	FILTKT	QDBRTVFD	Retrieve File Description
RTVJOBINF	JOBTKT	QUSRJOBI	Retrieve Job Information
RTVJOBSTK	JOBTKT	QWVRCSTK	Retrieve Job Stack
RTVOBJAUT	OBJ - pending	QSYRTVUA	Retrieve Object Authorities
RTVOBJD	RTVOBJD	QWCCVTDT	Convert Date Format
RTVOBJD	RTVOBJD	QUSROBJD	Retrieve Object Description
STGTKT	STGTKT	qsort	Quick Sort
TXTTKT	TXTTKT	cvthc	Convert Hex to Character
		cvtch	Convert Character to Hex
		QlgConvertCase	Convert Case between Upper and Lower
USRIDX	USRIDX	QUSADDUI	Add User Index Entry
		QUSCRTUI	Create User Index
		QUSDLTUI	Delete User Index
		QUSRMVUI	Remove User Index Entry
		QUSRUIAT	Retrieve User Index Attributes
		QUSRTVUI	Retrieve User Index Entry
USRSPC	USRSPC	QUSCYSAT	Change User Space Attributes
		QUSCRTUS	Create User Space
		QUSDLTUS	Delete User Space
		QUSRUSAT	Change User Space Attributes
		QUSPTRUS	Retrieve User Space Pointer
UNIX	UNIX	access	Check IFS File Authorities
		__errno	Retrieve Pointer to Unix Error
		strerror	Retrieve Pointer to Unix Error Structure
		open	Open IFS File
		chmod	Change Authorities for IFS File
		close	Close IFS File
		read	Read From IFS File
		write	Write To IFS File
		Qp0lSetAttr	Set Attributes like CCSID for an IFS File

This table focuses on the APIs used in the RPGIV modules in the iSeries-toolkit. CL API usage is not currently cataloged.

Module API Cross Reference