Public methods

applName

const char* applName()

Returns the 8-character name of the CICS® region.

Conditions

INVREQ

beginBrowse (1)

void beginBrowse (ResourceType resource,
                  const IccResourceId* resId = 0)

resource
An enumeration, defined in this class, that indicates the type of resource to be browsed within the CICS system.
resId
An optional pointer to an IccResourceId object that indicates the starting point for browsing through the resources.

beginBrowse (2)

void beginBrowse (ResourceType resource,
                  const char* resName)

resource
An enumeration, defined in this class, that indicates the type of resource to be browsed within the CICS system.
resName
The name of the resource that is to be the starting point for browsing the resources.

Signals the start of a browse through a set of CICS resources.

Conditions

END, FILENOTFOUND, ILLOGIC, NOTAUTH

dateFormat

const char* dateFormat()

Returns the default dateFormat for the CICS region.

Conditions

INVREQ

endBrowse

void endBrowse(ResourceType resource)

Signals the end of a browse through a set of CICS resources.

Conditions

END, FILENOTFOUND, ILLOGIC, NOTAUTH

freeStorage

void freeStorage(void*  pStorage)

Releases the storage obtained by the IccSystem getStorage method.

Conditions

INVREQ

getFile (1)

IccFile* getFile(const IccFileId& id)
id
A reference to an IccFileId object that identifies a CICS file.

getFile (2)

IccFile* getFile(const char* fileName)
fileName
The name of a CICS file.

Returns a pointer to the IccFile object identified by the argument.

Conditions

END, FILENOTFOUND, ILLOGIC, NOTAUTH

getNextFile

IccFile* getNextFile()

This method is only valid after a successful beginBrowse(IccSystem::file) call. It returns the next file object in the browse sequence in the CICS system.

Conditions

END, FILENOTFOUND, ILLOGIC, NOTAUTH

getStorage

void* getStorage (unsigned long size,
                  char initByte = -1,
                  unsigned long storageOpts = 0)

size
The amount of storage being requested, in bytes
initByte
The initial setting of all bytes in the allocated storage
storageOpts
An enumeration, defined in IccTask class, that affects the way that CICS allocates storage.

Obtains a block of storage of the requested size and returns a pointer to it. The storage is not released automatically at the end of task; it is only released when a freeStorage operation is performed.

Conditions

LENGERR, NOSTG

instance

static IccSystem* instance()

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

operatingSystem

char operatingSystem()

Returns a 1-character value that identifies the operating system under which CICS is running:

A
AIX®
N
Windows NT
P
OS/2
X
MVS/ESA

Conditions

NOTAUTH

operatingSystemLevel

unsigned short operatingSystemLevel()

Returns a halfword binary field giving the release number of the operating system under which CICS is running. The value returned is ten times the formal release number (the version number is not represented). For example, MVS/ESA Version 3 Release 2.1 would produce a value of 21.

Conditions

NOTAUTH

release

unsigned long release()

Returns the level of the CICS system as an integer set to 100 multiplied by the version number plus 10 multiplied by the release level. For example, CICS Transaction Server for z/OS® [Version 1] Release 3 would return 130.

Conditions

NOTAUTH

releaseText

const char* releaseText()

Returns the same as release, except as a 4-character string. For example, CICS Transaction Server for z/OS [Version 1] Release 3 would return "0130".

Conditions

NOTAUTH

sysId

IccSysId& sysId()

Returns a reference to the IccSysId object that identifies this CICS system.

Conditions

INVREQ

workArea

const IccBuf& workArea()

Returns a reference to the IccBuf object that holds the work area for the CICS system.

Conditions

INVREQ

[[ Contents Previous Page | Next Page Index ]]