The following table shows the correspondence between CICS® calls made using the EXEC CICS API and the equivalent calls from the Foundation Classes.
EXEC CICS | Class | Method |
---|---|---|
ABEND | IccTask | abend |
ADDRESS COMMAREA | IccControl | commArea |
ADDRESS CWA | IccSystem | workArea |
ADDRESS EIB | No direct access to EIB: please use appropriate method on appropriate class. | |
ADDRESS TCTUA | IccTerminal | workArea |
ADDRESS TWA | IccTask | workArea |
ALLOCATE | IccSession | allocate |
ASKTIME | IccClock | update |
ASSIGN ABCODE | IccAbendData | abendCode |
ASSIGN ABDUMP | IccAbendData | isDumpAvaliable |
ASSIGN ABPROGRAM | IccAbendData | programName |
ASSIGN ALTSCRNHT | IccTerminalData | alternateHeight |
ASSIGN ALTSCRNWD | IccTerminalData | alternateWidth |
ASSIGN APLKYBD | IccTerminalData | isAPLKeyboard |
ASSIGN APLTEXT | IccTerminalData | isAPLText |
ASSIGN ASRAINTRPT | IccAbendData | ASRAInterrupt |
ASSIGN ASRAKEY | IccAbendData | ASRAKeyType |
ASSIGN ASRAPSW | IccAbendData | ASRAPSW |
ASSIGN ASRAREGS | IccAbendData | ASRARegisters |
ASSIGN ASRASPC | IccAbendData | ASRASpaceType |
ASSIGN ASRASTG | IccAbendData | ASRAStorageType |
ASSIGN APPLID | IccSystem | applName |
ASSIGN BTRANS | IccTerminalData | isBTrans |
ASSIGN CMDSEC | IccTask | isCommandSecurityOn |
ASSIGN COLOR | IccTerminalData | isColor |
ASSIGN CWALENG | IccSystem | workArea |
ASSIGN DEFSCRNHT | IccTerminalData | defaultHeight |
ASSIGN DEFSCRNWD | IccTerminalData | defaultWidth |
ASSIGN EWASUPP | IccTerminalData | isEWA |
ASSIGN EXTDS | IccTerminalData | isExtended3270 |
ASSIGN FACILITY | IccTerminal | name |
ASSIGN FCI | IccTask | facilityType |
ASSIGN GCHARS | IccTerminalData | graphicCharSetId |
ASSIGN GCODES | IccTerminalData | graphicCharCodeSet |
ASSIGN GMMI | IccTerminalData | isGoodMorning |
ASSIGN HILIGHT | IccTerminalData | isHighlight |
ASSIGN INITPARM | IccControl | initData |
ASSIGN INITPARMLEN | IccControl | initData |
ASSIGN INVOKINGPROG | IccControl | callingProgramId |
ASSIGN KATAKANA | IccTerminalData | isKatakana |
ASSIGN NETNAME | IccTerminal | netName |
ASSIGN OUTLINE | IccTerminalData | isFieldOutline |
ASSIGN ORGABCODE | IccAbendData | originalAbendCode |
ASSIGN PRINSYSID | IccTask | principalSysId |
ASSIGN PROGRAM | IccControl | programId |
ASSIGN PS | IccTerminalData | isPS |
ASSIGN QNAME | IccTask | triggerDataQueueId |
ASSIGN RESSEC | IccTask | isResourceSecurityOn |
ASSIGN RESTART | IccTask | isRestarted |
ASSIGN SCRNHT | IccTerminal | height |
ASSIGN SCRNWD | IccTerminal | width |
ASSIGN SOSI | IccTerminalData | isSOSI |
ASSIGN STARTCODE | IccTask | startType, isCommitSupported, isStartDataAvailable |
ASSIGN SYSID | IccSystem | sysId |
ASSIGN TASKPRIORITY | IccTask | priority |
ASSIGN TCTUALENG | IccTerminal | workArea |
ASSIGN TEXTKYBD | IccTerminalData | isTextKeyboard |
ASSIGN TEXTPRINT | IccTerminalData | isTextPrint |
ASSIGN TWALENG | IccTask | workArea |
ASSIGN USERID | IccTask | userId |
ASSIGN VALIDATION | IccTerminalData | isValidation |
CANCEL | IccClock | cancelAlarm |
CANCEL | IccStartRequestQ | cancel |
CHANGE PASSWORD | IccUser | changePassword |
CHANGE TASK | IccTask | setPriority |
CONNECT PROCESS | IccSession | connectProcess |
CONVERSE | IccSession | converse |
DELAY | IccTask | delay |
DELETE | IccFile | deleteRecord |
DELETE | IccFile | deleteLockedRecord |
DELETEQ TD | IccDataQueue | empty |
DELETEQ TS | IccTempStore | empty |
DEQ | IccSemaphore | unlock |
DUMP TRANSACTION | IccTask | dump |
DUMP TRANSACTION | IccTask | setDumpOpts |
ENDBR | IccFileIterator | IccFileIterator (destructor) |
ENQ | IccSemaphore | lock |
ENQ | IccSemaphore | tryLock |
ENTER TRACENUM | IccTask | enterTrace |
EXTRACT ATTRIBUTES | IccSession | state, stateText |
EXTRACT PROCESS | IccSession | extractProcess |
FORMATTIME YYDDD, YYMMDD, etc | IccClock | date |
FORMATTIME DATE | IccClock | date |
FORMATTIME DATEFORM | IccSystem | dateFormat |
FORMATTIME DAYCOUNT | IccClock | daysSince1900 |
FORMATTIME DAYOFWEEK | IccClock | dayOfWeek |
FORMATTIME DAYOFMONTH | IccClock | dayOfMonth |
FORMATTIME MONTHOFYEAR | IccClock | monthOfYear |
FORMATTIME TIME | IccClock | time |
FORMATTIME YEAR | IccClock | year |
FREE | IccSession | free |
FREEMAIN | IccTask | freeStorage |
GETMAIN | IccTask | getStorage |
HANDLE ABEND | IccControl | setAbendHandler, cancelAbendHandler, resetAbendHandler |
INQUIRE FILE ACCESSMETHOD | IccFile | accessMethod |
INQUIRE FILE ADD | IccFile | isAddable |
INQUIRE FILE BROWSE | IccFile | isBrowsable |
INQUIRE FILE DELETE | IccFileControl | isDeletable |
INQUIRE FILE EMPTYSTATUS | IccFile | isEmptyOn |
INQUIRE FILE ENABLESTATUS | IccFile | enableStatus |
INQUIRE FILE KEYPOSITION | IccFile | keyPosition |
INQUIRE FILE OPENSTATUS | IccFile | openStatus |
INQUIRE FILE READ | IccFile | isReadable |
INQUIRE FILE RECORDFORMAT | IccFile | recordFormat |
INQUIRE FILE RECORDSIZE | IccFile | recordLength |
INQUIRE FILE RECOVSTATUS | IccFile | isRecoverable |
INQUIRE FILE TYPE | IccFile | type |
INQUIRE FILE UPDATE | IccFile | isUpdatable |
ISSUE ABEND | IccSession | issueAbend |
ISSUE CONFIRMATION | IccSession | issueConfirmation |
ISSUE ERROR | IccSession | issueError |
ISSUE PREPARE | IccSession | issuePrepare |
ISSUE SIGNAL | IccSession | issueSignal |
LINK | IccProgram | link |
LINK INPUTMSG INPUTMSGLEN | IccProgram | setInputMessage |
LOAD | IccProgram | load |
POST | IccClock | setAlarm |
READ | IccFile | readRecord |
READNEXT | IccFileIterator | readNextRecord |
READPREV | IccFileIterator | readPreviousRecord |
READQ TD | IccDataQueue | readItem |
READQ TS | IccTempStore | readItem |
RECEIVE (APPC) | IccSession | receive |
RECEIVE (3270) | IccTerminal | receive, receive3270Data |
RELEASE | IccProgram | unload |
RESETBR | IccFileIterator | reset |
RETRIEVE | IccStartRequestQ | retrieveData 1 |
Note:
The retrieveData method gets the start information
from CICS and stores it in the IccStartRequestQ object: the information can
then be accessed using data, queueName, returnTermId and
returnTransId methods. |
||
RETRIEVE INTO, LENGTH | IccStartRequestQ | data |
RETRIEVE QUEUE | IccStartRequestQ | queueName |
RETRIEVE RTRANSID | IccStartRequestQ | returnTransId |
RETRIEVE RTERMID | IccStartRequestQ | returnTermId |
RETURN | IccControl | main 2 |
Note:
Returning (using C++ reserved word return)
from method run in class IccControl results in an EXEC CICS RETURN. |
||
RETURN TRANSID | IccTerminal | setNextTransId 3 |
RETURN IMMEDIATE | IccTerminal | setNextTransId 3 |
RETURN COMMAREA LENGTH | IccTerminal | setNextCommArea 3 |
RETURN INPUTMSG, INPUTMSGLEN | IccTerminal | setNextInputMessage 3 |
Note:
Issue this call before returning from IccControl::run. |
||
REWRITE | IccFile | rewriteRecord |
SEND (APPC) | IccSession | send, sendInvite, sendLast |
SEND (3270) | IccTerminal | send, sendLine |
SEND CONTROL CURSOR | IccTerminal | setCursor setLine, setNewLine |
SEND CONTROL ERASE | IccTerminal | erase |
SEND CONTROL FREEKB | IccTerminal | freeKeyboard |
SET FILE ADD|BROWSE|DELETE|... | IccFile | setAccess |
SET FILE EMPTYSTATUS | IccFile | setEmptyOnOpen |
SET FILE OPEN STATUS|ENABLESTATUS | IccFile | setStatus |
SIGNOFF | IccTerminal | signoff |
SIGNON | IccTerminal | signon |
START TRANSID AT/AFTER | IccStartRequestQ | start 4 |
START TRANSID FROM LENGTH | IccStartRequestQ | setData, registerDataBuffer 4 |
START TRANSID NOCHECK | IccStartRequestQ | setStartOpts 4 |
START TRANSID PROTECT | IccStartRequestQ | setStartOpts 4 |
START TRANSID QUEUE | IccStartRequestQ | setQueueName 4 |
START TRANSID REQID | IccStartRequestQ | start 4 |
START TRANSID TERMID | IccStartRequestQ | start 4 |
START TRANSID USERID | IccStartRequestQ | start 4 |
START TRANSID RTERMID | IccStartRequestQ | setReturnTermId 4 |
START TRANSID RTRANSID | IccStartRequestQ | setReturnTransId 4 |
Note:
Use methods setData, setQueueName, setReturnTermId,
setReturnTransId, setStartOpts to set the state of the IccStartRequestQ object before issuing start requests with the start method. |
||
STARTBR | IccFileIterator | IccFileIterator (constructor) |
SUSPEND | IccTask | suspend |
SYNCPOINT | IccTask | commitUOW |
SYNCPOINT ROLLBACK | IccTask | rollBackUOW |
UNLOCK | IccFile | unlockRecord |
VERIFY PASSWORD | IccUser | verifyPassword |
WAIT CONVID | IccSession | flush |
WAIT EVENT | IccTask | waitOnAlarm |
WAIT EXTERNAL | IccTask | waitExternal |
WAIT JOURNALNUM | IccJournal | wait |
WRITE | IccFile | writeRecord |
WRITE OPERATOR | IccConsole | write, writeAndGetReply |
WRITEQ TD | IccDataQueue | writeItem |
WRITEQ TS | IccTempStore | writeItem, rewriteItem |