Published on System iNetwork (http://systeminetwork.com)
APIs by Example: The Coverage So Far
By tzura
Created May 22 2003 - 04:00

Between the APIs by Example tips in this newsletter and various articles in iSeries NEWS, there are quite a few sample programs that show how to use iSeries APIs. I thought it would be helpful to list the many API sample programs and articles available online and organize the list using the API categories IBM uses in its InfoCenter documentation at http://publib.boulder.ibm.com/iseries/v5r2/ic2924/info/apis/aplist.htm [1].

I'll be including many more APIs by Example sample code in upcoming newsletter issues. If there are any APIs in particular that you'd like to see covered (or if you have API code you'd like to share), please contact me at mailto:clubtechprogrammingtips@iseriesnetwork.com [2].

You can read about iSeries API topics at
http://www.iseriesnetwork.com/resources/artarchive/index.cfm?fuseaction=ListArticlesByTopic&ID=1 [3].

(To access some of these articles, you may need to have a paid iSeries Network Professional Membership.)

====== Communications -- TCP/IP Management APIs ======

List Network Connections (QtocLstNetCnn)
http://www.iseriesnetwork.com/article.cfm?ID=15777 [4]

====== Configuration -- General Configuration APIs ======

Retrieve Configuration Status (QDCRCFGS)
http://www.iseriesnetwork.com/article.cfm?ID=9298 [5]

Retrieve Device Description (QDCRDEVD)
http://www.iseriesnetwork.com/article.cfm?ID=6850 [6]

====== Data Conversion APIs ======

Code Conversion Allocation (QtqIconvOpen())
Code Conversion (iconv())
Code Conversion Deallocation (iconv_close())
http://www.iseriesnetwork.com/article.cfm?ID=10193 [7]

====== Database and File APIs ======

Retrieve Display File Description (QDFRTVFD)
http://www.iseriesnetwork.com/article.cfm?ID=14220 [8]

====== Dynamic Screen Manager - Low-Level Screen I/O APIs ======

Create Input Buffer (QsnCrtInpBuf)
Read Screen (QsnReadScr)
Retrieve Pointer to Data in Input Buffer (QsnRtvDta)
http://www.iseriesnetwork.com/article.cfm?ID=11206 [9]

Generate a Beep (QsnBeep)
http://www.iseriesnetwork.com/article.cfm?ID=15666 [10]

====== General Miscellaneous APIs ======

Convert Date and Time Format (QWCCVTDT)
http://www.iseriesnetwork.com/article.cfm?ID=10230 [11]
http://www.iseriesnetwork.com/article.cfm?ID=6324 [12]

====== Hierarchical File System APIs ======

Open Stream File (QHFOPNSF)
Read from Stream File (QHFRDSF)
Close Stream File (QHFCLOSF)
http://www.iseriesnetwork.com/article.cfm?ID=10193 [13]

====== ILE C Runtime Reference Functions ======

fopen
fgets
fputs
fclose
remove
errno
strerror
http://www.iseriesnetwork.com/article.cfm?ID=10214 [14]

====== ILE CEE -- Activation Group and Control Flow APIs ======

Register Call Stack Entry Termination User Exit Procedure (CEERTX)
http://www.iseriesnetwork.com/article.cfm?ID=14507 [15]

Normal End (CEETREC)
http://www.iseriesnetwork.com/article.cfm?ID=8009 [16]

====== ILE CEE -- Math APIs ======

Arcsine (CEESxASN)
Cosine (CEESxCOS)
http://www.iseriesnetwork.com/article.cfm?ID=13910 [17]

====== Journal and Commit APIs ======

Retrieve Journal Information (QjoRetrieveJournalInformation)
http://www.iseriesnetwork.com/article.cfm?ID=16430 [18]

Retrieve Journal Receiver Information (QjoRtvJrnReceiverInformation)
http://www.iseriesnetwork.com/article.cfm?ID=9295 [19]

====== Message Handling APIs ======

Send Scope Message (QMHSNDSM)
http://www.iseriesnetwork.com/article.cfm?ID=14408 [20]

Open List of Job Log Messages (QGYOLJBL)
Close List (QGYCLST)
http://www.iseriesnetwork.com/article.cfm?ID=10467 [21]

List Nonprogram Messages (QMHLSTM)
http://www.iseriesnetwork.com/article.cfm?ID=10246 [22]

Receive Program Message (QMHRCVPM)
Send Program Message (QMHSNDPM)
Send Nonprogram Message (QMHSNDM)
http://www.iseriesnetwork.com/article.cfm?ID=6337 [23]

Retrieve Message (QMHRTVM)
http://www.iseriesnetwork.com/article.cfm?ID=6858 [24]

====== National Language Support-related APIs ======

Convert Case (QLGCNVCS, QlgConvertCase)
http://www.iseriesnetwork.com/article.cfm?ID=14179 [25]

Sort (QLGSORT)
Sort Input/Output (QLGSRTIO)
http://www.iseriesnetwork.com/article.cfm?ID=1563 [26]

====== Networking -- Email APIs ======

Send MIME Mail (QtmmSendMail)
http://www.iseriesnetwork.com/article.cfm?ID=2806 [27]

====== Object -- Data Queue APIs ======

Retrieve Data Queue Description (QMHQRDQD)
http://www.iseriesnetwork.com/article.cfm?ID=15822 [28]

====== Object -- Object-related APIs ======

Change Object Description (QLICOBJD)
http://www.iseriesnetwork.com/article.cfm?ID=13644 [29]
http://www.iseriesnetwork.com/article.cfm?ID=16559 [30]

====== Object -- User Space APIs ======

Create User Space 9 (QUSCRTUS)
Change User Space (QUSCHGUS)
Retrieve User Space (QUSRTVUS)
http://www.iseriesnetwork.com/article.cfm?ID=2465 [31]

====== Office -- Office-related APIs ======

Search System Directory (QOKSCHD)
http://www.iseriesnetwork.com/article.cfm?ID=10130 [32]

Check Spelling (QTWCHKSP)
Aid Spelling (QTWAIDSP)
http://www.iseriesnetwork.com/article.cfm?ID=10594 [33]

====== Office -- AnyMail/400 Mail Server Framework APIs======

Create Mail Message (QzmfCrtMailMsg)
http://www.iseriesnetwork.com/article.cfm?ID=2672 [34]

====== Operational Assistant APIs ======

Send Message (QEZSNDMG)
http://www.iseriesnetwork.com/article.cfm?ID=2736 [35]

====== Print -- General Print APIs ======

Retrieve Output Queue Information (QSPROUTQ)
http://www.iseriesnetwork.com/article.cfm?ID=15147 [36]
http://www.iseriesnetwork.com/article.cfm?ID=15174 [37]

====== Print -- Spooled File APIs ======

List Spooled Files (QUSLSPL)
http://www.iseriesnetwork.com/article.cfm?ID=16304 [38]

====== Program and CL Command APIs ======

Create Program (QPRCRTPG)
http://www.iseriesnetwork.com/article.cfm?ID=15575 [39]

Execute Command (QCMDEXC)
http://www.iseriesnetwork.com/article.cfm?ID=13984 [40]
http://www.iseriesnetwork.com/article.cfm?ID=6788 [41]

Retrieve Command Definition (QCDRCMDD)
http://www.iseriesnetwork.com/article.cfm?ID=14754 [42]

List ILE Program Information (QBNLPGMI)
List Service Program Information (QBNLSPGM)
http://www.iseriesnetwork.com/article.cfm?ID=2403 [43]

====== Security -- Security-related APIs ======

Get Profile Handle (QSYGETPH)
Release Profile Handle (QSYRLSPH)
http://www.iseriesnetwork.com/article.cfm?ID=11399 [44]
http://www.iseriesnetwork.com/article.cfm?ID=10370 [45]

====== Security -- Validation List APIs ======

Add Validation List Entry (QsyAddValidationLstEntry())
Find Validation List Entry (QsyFindValidationLstEntry())
Change Validation List Entry (QsyChangeValidationLstEntry())
Remove Validation List Entry (QsyRemoveValidationLstEntry())
Verify Validation List Entry (QsyVerifyValidationLstEntry())
http://www.iseriesnetwork.com/article.cfm?ID=10197 [46]

====== Unix-type -- Integrated File System APIs ======

opendir() (Open directory)
readdir() (Read directory entry)
closedir() (Close directory)
lstat() (Get file or link information)
getpwuid() (Get user information for user ID)
http://www.iseriesnetwork.com/article.cfm?ID=10219 [47]

====== Unix-type -- Sockets APIs ======

bind() (Set a local address for the socket)
close() (Close file descriptor)
sendto() (Send data with a destination address using a socket descriptor)
setsockopt() (Allow an application to set characteristics of a socket)
recvmsg() (Receive data and remote address using a socket descriptor and multiple buffers)
http://www.iseriesnetwork.com/article.cfm?ID=2927 [48]

====== User Interface APIs ======

Display Long Text (QUILNGTX)
http://www.iseriesnetwork.com/article.cfm?ID=6799 [49]

====== Work Management APIs ======

Retrieve Call Stack (QWVRCSTK)
http://www.iseriesnetwork.com/article.cfm?ID=13860 [50]

Retrieve Job Information (QUSRJOBI)
http://www.iseriesnetwork.com/article.cfm?ID=10193 [51]
http://www.iseriesnetwork.com/article.cfm?ID=14242 [52]
http://www.iseriesnetwork.com/article.cfm?ID=14706 [53]

Retrieve Job Status (QWCRJBST)
http://www.iseriesnetwork.com/article.cfm?ID=13822 [54]

Retrieve System Status (QWCRSSTS)
http://www.iseriesnetwork.com/article.cfm?ID=11840 [55]

Retrieve System Values (QWCRSVAL)
http://www.iseriesnetwork.com/article.cfm?ID=11309 [56]
http://www.iseriesnetwork.com/article.cfm?ID=15631 [57]

Retrieve Job Description Information (QWDRJOBD)
http://www.iseriesnetwork.com/article.cfm?ID=14161 [58]

Set Profile Exit Programs (QWTSETPX) API
http://www.iseriesnetwork.com/article.cfm?ID=16301 [59]

© 2010 Penton Media, Inc.
Source URL: http://systeminetwork.com/node/61189

Links:
[1] http://publib.boulder.ibm.com/iseries/v5r2/ic2924/info/apis/aplist.htm
[2] mailto:clubtechprogrammingtips@iseriesnetwork.com
[3] http://systeminetwork.com/resources/artarchive/index.cfm?fuseaction=ListArticlesByTopic&ID=1
[4] http://systeminetwork.com/article.cfm?id=15777
[5] http://systeminetwork.com/article.cfm?id=9298
[6] http://systeminetwork.com/article.cfm?id=6850
[7] http://systeminetwork.com/article.cfm?id=10193
[8] http://systeminetwork.com/article.cfm?id=14220
[9] http://systeminetwork.com/article.cfm?id=11206
[10] http://systeminetwork.com/article.cfm?id=15666
[11] http://systeminetwork.com/article.cfm?id=10230
[12] http://systeminetwork.com/article.cfm?id=6324
[13] http://systeminetwork.com/article.cfm?id=10193
[14] http://systeminetwork.com/article.cfm?id=10214
[15] http://systeminetwork.com/article.cfm?id=14507
[16] http://systeminetwork.com/article.cfm?id=8009
[17] http://systeminetwork.com/article.cfm?id=13910
[18] http://systeminetwork.com/article.cfm?id=16430
[19] http://systeminetwork.com/article.cfm?id=9295
[20] http://systeminetwork.com/article.cfm?id=14408
[21] http://systeminetwork.com/article.cfm?id=10467
[22] http://systeminetwork.com/article.cfm?id=10246
[23] http://systeminetwork.com/article.cfm?id=6337
[24] http://systeminetwork.com/article.cfm?id=6858
[25] http://systeminetwork.com/article.cfm?id=14179
[26] http://systeminetwork.com/article.cfm?id=1563
[27] http://systeminetwork.com/article.cfm?id=2806
[28] http://systeminetwork.com/article.cfm?id=15822
[29] http://systeminetwork.com/article.cfm?id=13644
[30] http://systeminetwork.com/article.cfm?id=16559
[31] http://systeminetwork.com/article.cfm?id=2465
[32] http://systeminetwork.com/article.cfm?id=10130
[33] http://systeminetwork.com/article.cfm?id=10594
[34] http://systeminetwork.com/article.cfm?id=2672
[35] http://systeminetwork.com/article.cfm?id=2736
[36] http://systeminetwork.com/article.cfm?id=15147
[37] http://systeminetwork.com/article.cfm?id=15174
[38] http://systeminetwork.com/article.cfm?id=16304
[39] http://systeminetwork.com/article.cfm?id=15575
[40] http://systeminetwork.com/article.cfm?id=13984
[41] http://systeminetwork.com/article.cfm?id=6788
[42] http://systeminetwork.com/article.cfm?id=14754
[43] http://systeminetwork.com/article.cfm?id=2403
[44] http://systeminetwork.com/article.cfm?id=11399
[45] http://systeminetwork.com/article.cfm?id=10370
[46] http://systeminetwork.com/article.cfm?id=10197
[47] http://systeminetwork.com/article.cfm?id=10219
[48] http://systeminetwork.com/article.cfm?id=2927
[49] http://systeminetwork.com/article.cfm?id=6799
[50] http://systeminetwork.com/article.cfm?id=13860
[51] http://systeminetwork.com/article.cfm?id=10193
[52] http://systeminetwork.com/article.cfm?id=14242
[53] http://systeminetwork.com/article.cfm?id=14706
[54] http://systeminetwork.com/article.cfm?id=13822
[55] http://systeminetwork.com/article.cfm?id=11840
[56] http://systeminetwork.com/article.cfm?id=11309
[57] http://systeminetwork.com/article.cfm?id=15631
[58] http://systeminetwork.com/article.cfm?id=14161
[59] http://systeminetwork.com/article.cfm?id=16301