Functions

boolText

static const char* boolText (Bool test,
                             BoolSet set =
trueFalse)
test
A boolean value, defined in this structure, that has one of two values, chosen from a set of values given by set.
set
An enumeration, defined in this structure, that indicates from which pair of values test is selected. The default is to use true and false.

Returns the text that represents the boolean value described by the parameters, such as "yes" or "on".

catchException

static void catchException(IccException& exception)
exception
A reference to an IccException object that holds information about a particular type of exception.

This is the function of last resort, used to intercept IccException objects that the application fails to catch. It can be called from the main function in the stub program, listed in ICCMAIN header file, and described in main function. All OO CICS® programs should use this stub or a close equivalent.

conditionText

static const char* conditionText(IccCondition::Codes condition)

condition
An enumeration, defined in the IccCondition structure, that indicates the condition returned by a call to CICS.

Returns the symbolic name associated with a condition value. For example, if conditionText is called with condition of IccCondition::NORMAL, it returns "NORMAL", if it is called with condition of IccCondition::IOERR, it returns "IOERR", and so on.

initializeEnvironment

static void initializeEnvironment (ClassMemoryMgmt mem = cmmDefault,
                                   FamilySubset fam =
fsDefault,
                                   Icc::Bool EDF)

mem
An enumeration, defined in this structure, that indicates the memory management policy for the foundation classes.
fam
An enumeration, defined in this structure, that indicates whether the use of CICS features that are not available on all platforms is permitted.
EDF
A boolean that indicates whether EDF tracing is initially on.

Initializes the CICS Foundation Classes. The rest of the class library can only be called after this function has been called. It is called from the main function in the stub program, listed in ICCMAIN header file, and described in main function. All OO CICS programs should use this stub or a close equivalent.

isClassMemoryMgmtOn

static Bool isClassMemoryMgmtOn()

Returns a boolean value, defined in this structure, that indicates whether class memory management is on.

isEDFOn

static Bool isEDFOn()

Returns a Boolean value, defined in this structure, that indicates whether EDF tracing is on at the global level. (See setEDF in this structure, isEDFOn and setEDF in IccResource class on page IccResource class and Execution Diagnostic Facility).

isFamilySubsetEnforcementOn

static Bool isFamilySubsetEnforcementOn()

Returns a boolean value, defined in this structure, that indicates whether it is permitted to use CICS features that are not available on all platforms.

returnToCICS

static void returnToCICS()

This call returns the program flow to CICS. It is called by the main function in the stub program, listed in ICCMAIN header file, and described in main function. All OO CICS programs should use this stub or a close equivalent.

setEDF

static void setEDF(Icc::Bool onOff = off)
onOff
A boolean, defined in this structure, that indicates whether EDF tracing is enabled. As EDF is more suitable for tracing programs that use EXEC CICS calls than object oriented programs, the default is off.

Sets EDF tracing on or off at the global level.

unknownException

static void unknownException()

This function is called by the main function in ICCMAIN header file (see main function) and is used to intercept unknown exceptions. (See also catchException in this structure).

[[ Contents Previous Page | Next Page Index ]]