Public methods

callingProgramId

const IccProgramId& callingProgramId()

Returns a reference to an IccProgramId object that represents the program that called this program. The returned IccProgramId reference contains a null name if the executing program was not called by another program.

Conditions

INVREQ

cancelAbendHandler

void cancelAbendHandler()

Cancels a previously established exit at this logical program level.

Conditions

NOTAUTH, PGMIDERR

commArea

IccBuf& commArea()

Returns a reference to an IccBuf object that encapsulates the COMMAREA--the communications area of CICS® memory that is used for passing data between CICS programs and transactions.

Conditions

INVREQ

console

IccConsole* console()

Returns a pointer to the single IccConsole object. If this object has not yet been created, this method creates the object before returning a pointer to it.

initData

const IccBuf& initData()

Returns a reference to an IccBuf object that contains the initialization parameters specified for the program in the INITPARM system initialization parameter.

Conditions

INVREQ

instance

static IccControl* instance()

Returns a pointer to the single IccControl object. The object is created if it does not already exist.

isCreated

static Icc::Bool isCreated()

Returns a boolean value that indicates whether the IccControl object already exists. Possible values are true or false.

programId

const IccProgramId& programId()

Returns a reference to an IccProgramId object that refers to this executing program.

Conditions

INVREQ

resetAbendHandler

void resetAbendHandler()

Reactivates a previously cancelled abend handler for this logical program level. (See cancelAbendHandler on page cancelAbendHandler).

Conditions

NOTAUTH, PGMIDERR

returnProgramId

const IccProgramId& returnProgramId()

Returns a reference to an IccProgramId object that refers to the program that resumes control when this logical program level issues a return.

run

virtual void run() = 0

This method should be implemented in a subclass of IccControl by the application programmer.

session

IccSession* session()

Returns a pointer to the IccSession object that represents the principal facility for this program. An exception is thrown if this program does not have a session as its principal facility.

setAbendHandler (1)

void setAbendHandler(const IccProgramId& programId)
programId
A reference to the IccProgramId object that indicates which program is affected.

setAbendHandler (2)

void setAbendHandler(const char* programName)
programName
The name of the program affected.

These methods set the abend handler to the named program for this logical program level.

Conditions

NOTAUTH, PGMIDERR

startRequestQ

IccStartRequestQ* startRequestQ()

Returns a pointer to the IccStartRequestQ object. If this object has not yet been created, this method creates the object before returning a pointer to it.

system

IccSystem* system()

Returns a pointer to the IccSystem object. If this object has not yet been created, this method creates the object before returning a pointer to it.

task

IccTask* task()

Returns a pointer to the IccTask object. If this object has not yet been created, this method creates the object before returning a pointer to it.

terminal

IccTerminal* terminal()

Returns a pointer to the IccTerminal object. If this object has not yet been created, this method creates the object before returning a pointer to it.

This method has a condition, that the transaction must have a terminal as its principal facility. That is, there must be a physical terminal involved.

[[ Contents Previous Page | Next Page Index ]]