Cicparms control block – IBM SC34-5764-01 User Manual

Page 305

Advertising
background image

Entry Specifications when DEFCMD CICSLINK is specified:

When the code for the command program gets control by an EXEC CICS LINK, the CICS Commarea
contains the CICPARMS control block.

Before the program returns to the caller, it should place the return code it wants reflected into the
CICPARMS RETCODE field.

CICPARMS Control Block

The following table shows the CICPARMS control block for mapping passed parameters to assembler
routines.

Table 3. CICPARMS Control Block

Offset (Decimal)

Number of Bytes

Field Name

Description

0

12

Reserved for IBM use.

12

4

RXWBADDR

REXX work block address which is required to be placed into
register 10 before calls to the CICGETV stub routine (for REXX
variable access)

16

8

ENVNAME

Internal environment name taken from the DEFCMD or
DEFSCMD command definition

24

16

CICCMD

Internal command name taken from the command definition, or
in the case where an asterisk was specified, the actual
command name from the command string

40

4

ARGSTR

Address of the command argument string beginning with the
first non-blank character after the command name in the
command string

44

4

ARGLEN

Length of above argument string, in characters

48

4

PLIST

Address of a standard parsed parameter list of the command
line parsed into 8 character tokens, followed by a end of list
fence of hex high values (X'FFFFFFFFFFFFFFFF')

52

4

EPLIST

Address of an extended parameter list which matches up with
the standard PLIST above, but that is in a different format. The
extended PLIST has an 8 byte entry for each token described
above. The first 4 bytes is a fullword address of the start of the
string that comprises a token. The second word contains the
length of a token, in bytes.

56

4

RETCODE

Return code to be reflected in the exec immediately after the
execution of the command. This return code is automatically
placed into the special REXX variable RC.

60

4

Reserved for IBM use

64

4

USERWORD

For user use so information can be passed across multiple
command routine calls

68

4

Reserved for IBM use

72

4

Reserved for IBM use

76

1

TYPEFLAG

One character code that identifies the call type of the DEFCMD
or DEFSCMD definition. The code for REXX is R, for
CICSLINK is C, and for CICSLOAD is L

77

1

ITRACE

Internal trace flag. This is a one character code, which has a
value of 0 through 9 to indicate if internal tracing is active and
what level of tracing is active. The value of zero indicates the
normal situation of no tracing. Values from 1 to 9 indicate that
increasingly progressively detailed tracing has been requested.

Command Definition

Chapter 21. REXX/CICS Command Definition

283

Advertising