The opt parameter
Many methods have the same parameter, opt, which is described
under the abendCode method inabendCode.
const void* address() const
Returns the address of a program module in memory. This is only valid after
a successful load call.
Clears the current input message which was set by setInputMessage or registerInputMessage.
If the current input message was set using registerInputMessage then only the pointer is deleted: the buffer is left unchanged.
If the current input message was set using setInputMessage then clearInputMessage releases the memory used
by that buffer.
const void* entryPoint() const
Returns a pointer to the entry point of a loaded program module. This is
only valid after a successful load call.
unsigned long length() const
Returns the length of a program module. This is only valid after a successful load call.
void link (const IccBuf* commArea = 0,
const IccTransId* transId = 0,
CommitOpt opt = noCommitOnReturn)
- commArea
- An optional pointer to the IccBuf object that
contains the COMMAREA--the buffer used to pass information between the
calling program and the program that is being called
- transId
- An optional pointer to the IccTransId object that
indicates the name of the mirror transaction under which the program is to
run if it is a remote (DPL) program link
- opt
- An enumeration, defined in this class, that affects the behavior of
the link when the program is remote (DPL). The default (noCommitOnReturn)
is not to commit resource changes on the remote CICS® region until the current
task commits its resources. The alternative (commitOnReturn) means that the
resources of the remote program are committed whether or not this task subsequently
abends or encounters a problem.
Conditions:
INVREQ, NOTAUTH, PGMIDERR, SYSIDERR,
LENGERR, ROLLEDBACK, TERMERR
Restrictions
Links may be nested, that is, a linked program may link to another program. However, due to implementation restrictions, you
may only nest such programs 15 times. If this is exceeded, an exception is
thrown.
void load(LoadOpt opt = releaseAtTaskEnd)
- opt
- An enumeration, defined in this class, that indicates whether CICS should
automatically allow the program to be unloaded at task termination (releaseAtTaskEnd),
or not (hold).
Conditions:
NOTAUTH, PGMIDERR, INVREQ,
LENGERR
void registerInputMessage(const IccBuf& msg)
Store pointer to InputMessage for when the link method
is called.
void setInputMessage(const IccBuf& msg)
Specifies data to be made available, by the IccSession::receive() method, to the called program, when using the link method in this class.
Allow a program to be unloaded. It can be reloaded by a call to load.
Conditions
NOTAUTH, PGMIDERR, INVREQ
[[ Contents Previous Page | Next Page Index ]]