Contents

Preface
Who this book is for
What this book is about
What you need to know before reading this book
Notes on terminology
Figures
Tables
Installation and setup
Getting ready for object oriented CICS
Installed contents
Header files
Location
Dynamic link library
Location
Sample source code
Location
Running the sample applications.
Other datasets for CICS Transaction Server for z/OS
Hello World
Compile and link "Hello World"
Running "Hello World" on your CICS server
Expected Output from "Hello World"
Using the CICS foundation classes
C++ Objects
Creating an object
Using an object
Deleting an object
Overview of the foundation classes
Base classes
Resource identification classes
Resource classes
Support Classes
Using CICS resources
Creating a resource object
Calling methods on a resource object
Buffer objects
IccBuf class
Data area ownership
Data area extensibility
IccBuf constructors
IccBuf methods
Working with IccResource subclasses
Using CICS Services
File control
Reading records
Writing records
Updating records
Deleting records
Browsing records
Example of file control
Program control
Starting transactions asynchronously
Starting transactions
Accessing start data
Cancelling unexpired start requests
Example of starting transactions
Transient Data
Reading data
Writing data
Deleting queues
Example of managing transient data
Temporary storage
Reading items
Writing items
Updating items
Deleting items
Example of Temporary Storage
Terminal control
Sending data to a terminal
Receiving data from a terminal
Finding out information about a terminal
Example of terminal control
Time and date services
Example of time and date services
Compiling, executing, and debugging
Compiling Programs
Executing Programs
Debugging Programs
Symbolic Debuggers
Tracing a Foundation Class Program
Execution Diagnostic Facility
Conditions, errors, and exceptions
Foundation Class Abend codes
C++ Exceptions and the Foundation Classes
CICS conditions
Manual condition handling (noAction)
Automatic condition handling (callHandleEvent)
Exception handling (throwException)
Severe error handling (abendTask)
Platform differences
Object level
Method level
Parameter level
Miscellaneous
Polymorphic Behavior
Example of polymorphic behavior
Storage management
Parameter passing conventions
Scope of data in IccBuf reference returned from 'read' methods
Foundation Classes--reference
Icc structure
Functions
boolText
catchException
conditionText
initializeEnvironment
isClassMemoryMgmtOn
isEDFOn
isFamilySubsetEnforcementOn
returnToCICS
setEDF
unknownException
Enumerations
Bool
BoolSet
ClassMemoryMgmt
FamilySubset
GetOpt
Platforms
IccAbendData class
IccAbendData constructor (protected)
Constructor
Public methods
abendCode
ASRAInterrupt
ASRAKeyType
ASRAPSW
ASRARegisters
ASRASpaceType
ASRAStorageType
instance
isDumpAvailable
originalAbendCode
programName
Inherited public methods
Inherited protected methods
IccAbsTime class
IccAbsTime constructor
Constructor (1)
Constructor (2)
Public methods
date
dayOfMonth
dayOfWeek
daysSince1900
hours
milliSeconds
minutes
monthOfYear
operator=
packedDecimal
seconds
time
timeInHours
timeInMinutes
timeInSeconds
year
Inherited public methods
Inherited protected methods
IccAlarmRequestId class
IccAlarmRequestId constructors
Constructor (1)
Constructor (2)
Constructor (3)
Public methods
isExpired
operator= (1)
operator= (2)
operator= (3)
setTimerECA
timerECA
Inherited public methods
Inherited protected methods
IccBase class
IccBase constructor (protected)
Constructor
Public methods
classType
className
customClassNum
operator delete
operator new
Protected methods
setClassName
setCustomClassNum
Enumerations
ClassType
NameOpt
IccBuf class
IccBuf constructors
Constructor (1)
Constructor (2)
Constructor (3)
Constructor (4)
Public methods
append (1)
append (2)
assign (1)
assign (2)
cut
dataArea
dataAreaLength
dataAreaOwner
dataAreaType
dataLength
insert
isFMHContained
operator const char*
operator= (1)
operator= (2)
operator+= (1)
operator+= (2)
operator==
operator!=
operator<< (1)
operator<< (2)
operator<< (3)
operator<< (4)
operator<< (5)
operator<< (6)
operator<< (7)
operator<< (8)
operator<< (9)
operator<< (10)
operator<< (11)
operator<< (12)
operator<< (13)
operator<< (14)
operator<< (15)
overlay
replace
setDataLength
setFMHContained
Inherited public methods
Inherited protected methods
Enumerations
DataAreaOwner
DataAreaType
IccClock class
IccClock constructor
Constructor
Public methods
absTime
cancelAlarm
date
dayOfMonth
dayOfWeek
daysSince1900
milliSeconds
monthOfYear
setAlarm
time
update
year
Inherited public methods
Inherited protected methods
Enumerations
DateFormat
DayOfWeek
MonthOfYear
UpdateMode
IccCondition structure
Enumerations
Codes
Range
IccConsole class
IccConsole constructor (protected)
Constructor
Public methods
instance
put
replyTimeout
resetRouteCodes
setAllRouteCodes
setReplyTimeout (1)
setReplyTimeout (2)
setRouteCodes
write
writeAndGetReply
Inherited public methods
Inherited protected methods
Enumerations
SeverityOpt
IccControl class
IccControl constructor (protected)
Constructor
Public methods
callingProgramId
cancelAbendHandler
commArea
console
initData
instance
isCreated
programId
resetAbendHandler
returnProgramId
run
session
setAbendHandler (1)
setAbendHandler (2)
startRequestQ
system
task
terminal
Inherited public methods
Inherited protected methods
IccConvId class
IccConvId constructors
Constructor (1)
Constructor (2)
Public methods
operator= (1)
operator= (2)
Inherited public methods
Inherited protected methods
IccDataQueue class
IccDataQueue constructors
Constructor (1)
Constructor (2)
Public methods
clear
empty
get
put
readItem
writeItem (1)
writeItem (2)
Inherited public methods
Inherited protected methods
IccDataQueueId class
IccDataQueueId constructors
Constructor (1)
Constructor (2)
Public methods
operator= (1)
operator= (2)
Inherited public methods
Inherited protected methods
IccEvent class
IccEvent constructor
Constructor
Public methods
className
classType
condition
conditionText
methodName
summary
Inherited public methods
Inherited protected methods
IccException class
IccException constructor
Constructor
Public methods
className
classType
message
methodName
number
summary
type
typeText
Inherited public methods
Inherited protected methods
Enumerations
Type
IccFile class
IccFile constructors
Constructor (1)
Constructor (2)
Public methods
access
accessMethod
beginInsert(VSAM only)
deleteLockedRecord
deleteRecord
enableStatus
endInsert(VSAM only)
isAddable
isBrowsable
isDeletable
isEmptyOnOpen
isReadable
isRecoverable
isUpdatable
keyLength
keyPosition
openStatus
readRecord
recordFormat
recordIndex
recordLength
registerRecordIndex
rewriteRecord
setAccess
setEmptyOnOpen
setStatus
type
unlockRecord
writeRecord
Inherited public methods
Inherited protected methods
Enumerations
Access
ReadMode
SearchCriterion
Status
IccFileId class
IccFileId constructors
Constructor (1)
Constructor (2)
Public methods
operator= (1)
operator= (2)
Inherited public methods
Inherited protected methods
IccFileIterator class
IccFileIterator constructor
Constructor
Public methods
readNextRecord
readPreviousRecord
reset
Inherited public methods
Inherited protected methods
IccGroupId class
IccGroupId constructors
Constructor (1)
Constructor (2)
Public methods
operator= (1)
operator= (2)
Inherited public methods
Inherited protected methods
IccJournal class
IccJournal constructors
Constructor (1)
Constructor (2)
Public methods
clearPrefix
journalTypeId
put
registerPrefix
setJournalTypeId (1)
setJournalTypeId (2)
setPrefix (1)
setPrefix (2)
wait
writeRecord (1)
writeRecord (2)
Inherited public methods
Inherited protected methods
Enumerations
Options
IccJournalId class
IccJournalId constructors
Constructor (1)
Constructor (2)
Public methods
number
operator= (1)
operator= (2)
Inherited public methods
Inherited protected methods
IccJournalTypeId class
IccJournalTypeId constructors
Constructor (1)
Constructor (2)
Public methods
operator= (1)
operator= (2)
Inherited public methods
Inherited protected methods
IccKey class
IccKey constructors
Constructor (1)
Constructor (2)
Constructor (3)
Public methods
assign
completeLength
kind
operator= (1)
operator= (2)
operator= (3)
operator== (1)
operator== (2)
operator== (3)
operator!= (1)
operator!= (2)
operator!= (3)
setKind
value
Inherited public methods
Inherited protected methods
Enumerations
Kind
IccLockId class
IccLockId constructors
Constructor (1)
Constructor (2)
Public methods
operator= (1)
operator= (2)
Inherited public methods
Inherited protected methods
IccMessage class
IccMessage constructor
Constructor
Public methods
className
methodName
number
summary
text
Inherited public methods
Inherited protected methods
IccPartnerId class
IccPartnerId constructors
Constructor (1)
Constructor (2)
Public methods
operator= (1)
operator= (2)
Inherited public methods
Inherited protected methods
IccProgram class
IccProgram constructors
Constructor (1)
Constructor (2)
Public methods
address
clearInputMessage
entryPoint
length
link
load
registerInputMessage
setInputMessage
unload
Inherited public methods
Inherited protected methods
Enumerations
CommitOpt
LoadOpt
IccProgramId class
IccProgramId constructors
Constructor (1)
Constructor (2)
Public methods
operator= (1)
operator= (2)
Inherited public methods
Inherited protected methods
IccRBA class
IccRBA constructor
Constructor
Public methods
operator= (1)
operator= (2)
operator== (1)
operator== (2)
operator!= (1)
operator!= (2)
number
Inherited public methods
Inherited protected methods
IccRecordIndex class
IccRecordIndex constructor (protected)
Constructor
Public methods
length
type
Inherited public methods
Inherited protected methods
Enumerations
Type
IccRequestId class
IccRequestId constructors
Constructor (1)
Constructor (2)
Constructor (3)
Public methods
operator= (1)
operator= (2)
Inherited public methods
Inherited protected methods
IccResource class
IccResource constructor (protected)
Constructor
Public methods
actionOnCondition
actionOnConditionAsChar
actionsOnConditionsText
clear
condition
conditionText
get
handleEvent
id
isEDFOn
isRouteOptionOn
name
put
routeOption
setActionOnAnyCondition
setActionOnCondition
setActionsOnConditions
setEDF
setRouteOption (1)
setRouteOption (2)
Inherited public methods
Inherited protected methods
Enumerations
ActionOnCondition
HandleEventReturnOpt
ConditionType
IccResourceId class
IccResourceId constructors (protected)
Constructor (1)
Constructor (2)
Public methods
name
nameLength
Protected methods
operator=
Inherited public methods
Inherited protected methods
IccRRN class
IccRRN constructors
Constructor
Public methods
operator= (1)
operator= (2)
operator== (1)
operator== (2)
operator!= (1)
operator!= (2)
number
Inherited public methods
Inherited protected methods
IccSemaphore class
IccSemaphore constructor
Constructor (1)
Constructor (2)
Public methods
lifeTime
lock
tryLock
type
unlock
Inherited public methods
Inherited protected methods
Enumerations
LockType
LifeTime
IccSession class
IccSession constructors (public)
Constructor (1)
Constructor (2)
Constructor (3)
IccSession constructor (protected)
Constructor
Public methods
allocate
connectProcess (1)
connectProcess (2)
connectProcess (3)
converse
convId
errorCode
extractProcess
flush
free
get
isErrorSet
isNoDataSet
isSignalSet
issueAbend
issueConfirmation
issueError
issuePrepare
issueSignal
PIPList
process
put
receive
send (1)
send (2)
sendInvite (1)
sendInvite (2)
sendLast (1)
sendLast (2)
state
stateText
syncLevel
Inherited public methods
Inherited protected methods
Enumerations
AllocateOpt
SendOpt
StateOpt
SyncLevel
IccStartRequestQ class
IccStartRequestQ constructor (protected)
Constructor
Public methods
cancel
clearData
data
instance
queueName
registerData
reset
retrieveData
returnTermId
returnTransId
setData
setQueueName
setReturnTermId (1)
setReturnTermId (2)
setReturnTransId (1)
setReturnTransId (2)
setStartOpts
start
Inherited public methods
Inherited protected methods
Enumerations
RetrieveOpt
ProtectOpt
CheckOpt
IccSysId class
IccSysId constructors
Constructor (1)
Constructor (2)
Public methods
operator= (1)
operator= (2)
Inherited public methods
Inherited protected methods
IccSystem class
IccSystem constructor (protected)
Constructor
Public methods
applName
beginBrowse (1)
beginBrowse (2)
dateFormat
endBrowse
freeStorage
getFile (1)
getFile (2)
getNextFile
getStorage
instance
operatingSystem
operatingSystemLevel
release
releaseText
sysId
workArea
Inherited public methods
Inherited protected methods
Enumerations
ResourceType
IccTask class
IccTask Constructor (protected)
Constructor
Public methods
abend
abendData
commitUOW
delay
dump
enterTrace
facilityType
freeStorage
getStorage
instance
isCommandSecurityOn
isCommitSupported
isResourceSecurityOn
isRestarted
isStartDataAvailable
number
principalSysId
priority
rollBackUOW
setDumpOpts
setPriority
setWaitText
startType
suspend
transId
triggerDataQueueId
userId
waitExternal
waitOnAlarm
workArea
Inherited public methods
Inherited protected methods
Enumerations
AbendHandlerOpt
AbendDumpOpt
DumpOpts
FacilityType
StartType
StorageOpts
TraceOpt
WaitPostType
WaitPurgeability
IccTempStore class
IccTempStore constructors
Constructor (1)
Constructor (2)
Public methods
clear
empty
get
numberOfItems
put
readItem
readNextItem
rewriteItem
writeItem (1)
writeItem (2)
Inherited public methods
Inherited protected methods
Enumerations
Location
NoSpaceOpt
IccTempStoreId class
IccTempStoreId constructors
Constructor (1)
Constructor (2)
Public methods
operator= (1)
operator= (2)
Inherited public methods
Inherited protected methods
IccTermId class
IccTermId constructors
Constructor (1)
Constructor (2)
Public methods
operator= (1)
operator= (2)
Inherited public methods
Inherited protected methods
IccTerminal class
IccTerminal constructor (protected)
Constructor
Public methods
AID
clear
cursor
data
erase
freeKeyboard
get
height
inputCursor
instance
line
netName
operator<< (1)
operator<< (2)
operator<< (3)
operator<< (4)
operator<< (5)
operator<< (6)
operator<< (7)
operator<< (8)
operator<< (9)
operator<< (10)
operator<< (11)
operator<< (12)
operator<< (13)
operator<< (14)
operator<< (15)
operator<< (16)
operator<< (17)
operator<< (18)
put
receive
receive3270Data
send (1)
send (2)
send (3)
send (4)
send3270Data (1)
send3270Data (2)
send3270Data (3)
send3270Data (4)
sendLine (1)
sendLine (2)
sendLine (3)
sendLine (4)
setColor
setCursor (1)
setCursor (2)
setHighlight
setLine
setNewLine
setNextCommArea
setNextInputMessage
setNextTransId
signoff
signon (1)
signon (2)
waitForAID (1)
waitForAID (2)
width
workArea
Inherited public methods
Inherited protected methods
Enumerations
AIDVal
Case
Color
Highlight
NextTransIdOpt
IccTerminalData class
IccTerminalData constructor (protected)
Constructor
Public methods
alternateHeight
alternateWidth
defaultHeight
defaultWidth
graphicCharCodeSet
graphicCharSetId
isAPLKeyboard
isAPLText
isBTrans
isColor
isEWA
isExtended3270
isFieldOutline
isGoodMorning
isHighlight
isKatakana
isMSRControl
isPS
isSOSI
isTextKeyboard
isTextPrint
isValidation
Inherited public methods
Inherited protected methods
IccTime class
IccTime constructor (protected)
Constructor
Public methods
hours
minutes
seconds
timeInHours
timeInMinutes
timeInSeconds
type
Inherited public methods
Inherited protected methods
Enumerations
Type
IccTimeInterval class
IccTimeInterval constructors
Constructor (1)
Constructor (2)
Public methods
operator=
set
Inherited public methods
Inherited protected methods
IccTimeOfDay class
IccTimeOfDay constructors
Constructor (1)
Constructor (2)
Public methods
operator=
set
Inherited public methods
Inherited protected methods
IccTPNameId class
IccTPNameId constructors
Constructor (1)
Constructor (2)
Public methods
operator= (1)
operator= (2)
Inherited public methods
Inherited protected methods
IccTransId class
IccTransId constructors
Constructor (1)
Constructor (2)
Public methods
operator= (1)
operator= (2)
Inherited public methods
Inherited protected methods
IccUser class
IccUser constructors
Constructor (1)
Constructor (2)
Public methods
changePassword
daysUntilPasswordExpires
ESMReason
ESMResponse
groupId
invalidPasswordAttempts
language
lastPasswordChange
lastUseTime
passwordExpiration
setLanguage
verifyPassword
Inherited public methods
Inherited protected methods
IccUserId class
IccUserId constructors
Constructor (1)
Constructor (2)
Public methods
operator= (1)
operator= (2)
Inherited public methods
Inherited protected methods
IccValue structure
Enumeration
CVDA
main function
Appendixes
Appendix A. Mapping EXEC CICS calls to Foundation Class methods
Appendix B. Mapping Foundation Class methods to EXEC CICS calls
Appendix C. Output from sample programs
ICC$BUF (IBUF)
ICC$CLK (ICLK)
ICC$DAT (IDAT)
ICC$EXC1 (IEX1)
ICC$EXC2 (IEX2)
ICC$EXC3 (IEX3)
ICC$FIL (IFIL)
ICC$HEL (IHEL)
ICC$JRN (IJRN)
ICC$PRG1 (IPR1)
First Screen
Second Screen
ICC$RES1 (IRS1)
ICC$RES2 (IRS2)
ICC$SEM (ISEM)
ICC$SES1 (ISE1)
ICC$SES2 (ISE2)
ICC$SRQ1 (ISR1)
ICC$SRQ2 (ISR2)
ICC$SYS (ISYS)
ICC$TMP (ITMP)
ICC$TRM (ITRM)
ICC$TSK (ITSK)
Glossary
Bibliography
The CICS Transaction Server for z/OS library
The entitlement set
PDF-only books
Other CICS books
Related books
C++ Programming
CICS client manuals
Accessibility
Index
Notices
Trademarks
[[ Contents Previous Page | Next Page Index ]]