Public methods

These are the public methods in this class.

The opt parameter

Many methods have the same parameter, opt, which is described under the abendCode method inabendCode.

abend
Requests CICS to abend this task.
abendData
commitUOW
delay
Requests that this task be delayed for an interval of time, or until a specific time.
dump
Requests CICS to take a memory dump for this task. (See also setDumpOpts.) Returns the character identifier of the dump.
enterTrace
Writes a user trace entry in the CICS trace table.
facilityType
Returns an enumeration, defined in this class, that indicates what type of principal facility this task has. This is usually a terminal, such as when the task was started by someone keying a transaction name on a CICS terminal. It is a session if the task is the back end of a mapped APPC conversation.
freeStorage
Releases the storage obtained by the IccTask getStorage method.
getStorage
Obtains a block of storage of the requested size. The storage is released automatically at the end of task, or when the freeStorage operation is performed. See also getStorage on page getStorage in IccSystemclass.
instance
Returns a pointer to the singleton IccTask object. The object is created if it does not already exist.
isCommandSecurityOn
isCommitSupported
Returns a boolean, defined in Icc structure that indicates whether this task can support the commit method. This method returns true in most environments; the exception to this is in a DPL environment (see link on page link in IccProgram).
isResourceSecurityOn
Returns a boolean, defined in Icc structure, that indicates whether this task is subject to resource security checking.
isRestarted
Returns a boolean, defined in Icc structure, that indicates whether this task has been automatically restarted by CICS.
isStartDataAvailable
Returns a boolean, defined in Icc structure, that indicates whether start data is available for this task. See the retrieveData method in IccStartRequestQ class if start data is available.
number
Returns the number of this task, unique within the CICS system.
principalSysId
priority
Returns the priority for this task.
rollBackUOW
Roll back (backout) the resource updates associated with the current UOW within this task.
setDumpOpts
Set the dump options for this task. This method affects the behavior of the dump method defined in this class.
setPriority
Changes the dispatch priority of this task.
setWaitText
Sets the text that will appear when someone inquires on this task while it is suspended as a result of a waitExternal or waitOnAlarm method call.
startType
suspend
Suspend this task, allowing other tasks to be dispatched.
transId
triggerDataQueueId
userId
Returns the ID of the user associated with this task.
waitExternal
Waits for events that post Event Control Blocks (ECBs).
waitOnAlarm
Suspends the task until the alarm goes off (expires).
workArea
Returns a reference to the IccBuf object that holds the work area for this task.

Parent topic: IccTask class