Public methods

The opt parameter

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

instance

static IccConsole* instance()

Returns a pointer to the single IccConsole object that represents the CICS® console. If the object does not already exist, it is created by this method.

put

virtual void put(const IccBuf& send)

send
A reference to an IccBuf object that contains the data that is to be written to the console.

Writes the data in send to the CICS console. put is a synonym for write. See Polymorphic Behavior.

replyTimeout

unsigned long replyTimeout() const

Returns the length of the reply timeout in milliseconds.

resetRouteCodes

void resetRouteCodes()

Removes all route codes held in the IccConsole object.

setAllRouteCodes

void setAllRouteCodes()

Sets all possible route codes in the IccConsole object, that is, 1 through 28.

setReplyTimeout (1)

void setReplyTimeout(IccTimeInterval& interval)
interval
A reference to a IccTimeInterval object that describes the length of the time interval required.

setReplyTimeout (2)

void setReplyTimeout(unsigned long seconds)
seconds
The length of the time interval required, in seconds.

The two different forms of this method are used to set the length of the reply timeout.

setRouteCodes

void setRouteCodes (unsigned short numRoutes,
                    ...)

numRoutes
The number of route codes provided in this call--the number of arguments that follow this one.
...
One or more arguments, the number of which is given by numRoutes. Each argument is a route code, of type unsigned short, in the range 1 to 28.

Saves route codes in the object for use on subsequent write and writeAndGetReply calls. Up to 28 codes can be held in this way.

write

void write (const IccBuf& send,
            SeverityOpt opt =
none)

send
A reference to an IccBuf object that contains the data that is to be written to the console.
opt
An enumeration, defined below, that indicates the severity of the console message.

Writes the data in send to the CICS console.

Conditions

INVREQ, LENGERR, EXPIRED

writeAndGetReply

const IccBuf& writeAndGetReply (const IccBuf& send,
                                SeverityOpt opt=
none)
send
A reference to an IccBuf object that contains the data that is to be written to the console.
opt
An enumeration, defined below, that indicates the severity of the console message.

Writes the data in send to the CICS console and returns a reference to an IccBuf object that contains the reply from the CICS operator.

Conditions

INVREQ, LENGERR, EXPIRED

[[ Contents Previous Page | Next Page Index ]]