Programming Interface Information: This information is NOT intended to be used as Programming Interfaces of z/VM.

#### DCMPI

Prolog

Control Block Contents
DCMPI DSECT

Storage Layout

Cross Reference (Contains links to field and bit definitions)

#### DCMPI Prolog

     NAME       : HCPDCMPI
     DESCRIPTION: Define Command Program Interface Plist
     DSECT      : DCMPI
     FUNCTION   : The Define Command Program Interface Plist is used to
                  pass data to HCPDCMPI for the purpose of defining a
                  command dynamically.
     LOCATED BY : R1 at entry to HCPDCMPI
     CREATED BY : Whoever calls HCPDCMPI
     DELETED BY : Whoever calls HCPDCMPI
     REFERENCES : HCPCLASS - Privilege class definitions
                  HCPCMDBK - Command Definition Block
     SERIALIZED : None.
     COMMENTS   :

#### DCMPI Control Block Content

#### DCMPI DSECT

    Hex   Dec Type/Val   Lng Label (dup)    Comments
    ---- ---- --------- ---- -------------- --------
    0000    0 Structure      DCMPI          Define Command Program Interface Plist
    0000    0 Signed       2 DCMPIPLL       Length of plist, in bytes.
                                            DCMPIWRK-DCMPI, plus whatever has
                                            been placed at DCMPIWRK.
    0002    2 Signed       2 *              Reserved
    0004    4 Signed       4 *              Reserved
    0008    8 Signed       2 DCMPICMO       Offset to command name
    000A   10 Signed       2 DCMPICML       Length of command name. If this
                                            value is 0, then the command at
                                            offset DCMPICMO must have a
                                            trailing blank as a delimiter.
    000C   12 Signed       2 DCMPICMA       Abbreviation length or 0
    000E   14 Signed       2 *              Reserved
    0010   16 Signed       2 DCMPISCO       Offset to subcommand name or zero
                                            if none
    0012   18 Signed       2 DCMPISCL       Length of subcommand name If this
                                            value is 0, then the subcommand
                                            at offset DCMPISCO must have a
                                            trailing blank as a delimiter.
    0014   20 Signed       2 DCMPISCA       Abbreviation length or 0
    0016   22 Signed       2 *              Reserved
    0018   24 Signed       2 DCMPIALO       Offset to full alias name or zero
                                            if none
    001A   26 Signed       2 DCMPIALL       Length of full alias name
    001C   28 Signed       2 *              Reserved
    001E   30 Signed       2 *              Reserved
    0020   32 Character    8 DCMPIEPN       CMDEPNAM, entry point name
    0028   40 Bitstring    4 DCMPICLS (0)   CMDCLASS, user priv classes
    0028   40 Bitstring    1 DCMPICL0       classes A-H
              1... ....      CLASSA         X'80' CLASSA CLASS A FUNCTIONS
              .1.. ....      CLASSB         X'40' CLASSB CLASS B FUNCTIONS
              ..1. ....      CLASSC         X'20' CLASSC CLASS C FUNCTIONS
              ...1 ....      CLASSD         X'10' CLASSD CLASS D FUNCTIONS
              .... 1...      CLASSE         X'08' CLASSE CLASS E FUNCTIONS
              .... .1..      CLASSF         X'04' CLASSF CLASS F FUNCTIONS
              .... ..1.      CLASSG         X'02' CLASSG CLASS G FUNCTIONS
              .... ...1      CLASSH         X'01' CLASSH CLASS H FUNCTIONS
    0029   41 Bitstring    1 DCMPICL1       classes I-P
              1... ....      CLASSI         X'80' CLASSI CLASS I FUNCTIONS
              .1.. ....      CLASSJ         X'40' CLASSJ CLASS J FUNCTIONS
              ..1. ....      CLASSK         X'20' CLASSK CLASS K FUNCTIONS
              ...1 ....      CLASSL         X'10' CLASSL CLASS L FUNCTIONS
              .... 1...      CLASSM         X'08' CLASSM CLASS M FUNCTIONS
              .... .1..      CLASSN         X'04' CLASSN CLASS N FUNCTIONS
              .... ..1.      CLASSO         X'02' CLASSO CLASS O FUNCTIONS
              .... ...1      CLASSP         X'01' CLASSP CLASS P FUNCTIONS
    002A   42 Bitstring    1 DCMPICL2       classes Q-X
              1... ....      CLASSQ         X'80' CLASSQ CLASS Q FUNCTIONS
              .1.. ....      CLASSR         X'40' CLASSR CLASS R FUNCTIONS
              ..1. ....      CLASSS         X'20' CLASSS CLASS S FUNCTIONS
              ...1 ....      CLASST         X'10' CLASST CLASS T FUNCTIONS
              .... 1...      CLASSU         X'08' CLASSU CLASS U FUNCTIONS
              .... .1..      CLASSV         X'04' CLASSV CLASS V FUNCTIONS
              .... ..1.      CLASSW         X'02' CLASSW CLASS W FUNCTIONS
              .... ...1      CLASSX         X'01' CLASSX CLASS X FUNCTIONS
    002B   43 Bitstring    1 DCMPICL3       classes Y-6
              1... ....      CLASSY         X'80' CLASSY CLASS Y FUNCTIONS
              .1.. ....      CLASSZ         X'40' CLASSZ CLASS Z FUNCTIONS
              ..1. ....      CLASS1         X'20' CLASS1 CLASS 1 FUNCTIONS
              ...1 ....      CLASS2         X'10' CLASS2 CLASS 2 FUNCTIONS
              .... 1...      CLASS3         X'08' CLASS3 CLASS 3 FUNCTIONS
              .... .1..      CLASS4         X'04' CLASS4 CLASS 4 FUNCTIONS
              .... ..1.      CLASS5         X'02' CLASS5 CLASS 5 FUNCTIONS
              .... ...1      CLASS6         X'01' CLASS6 CLASS 6 FUNCTIONS
                                            CLASSALL DEFINITION
              DCMPICL3       CLASSALL       X'FFFFFFFF' CLASSALL ALL
                                            FUNCTIONS ALLOWED
    002C   44 Bitstring    1 DCMPIIBM       CMDIBMCL, IBM class
              ..1. 11..      DCMPIIB0       00001 DCMPIIBM+0,1,C'B' classes
                                            A-G
    002D   45 Bitstring    1 DCMPIFL        CMDFLAG
              1... ....      CMDALOG        X'80' CMDALOG Command allowed
                                            before LOGON
              .1.. ....      CMDOLOG        X'40' CMDOLOG Command allowed
                                            only at LOGON
              ..1. ....      CMDALIAS       X'20' CMDALIAS Entry is an
                                            'ALIAS'
              ...1 ....      CMDENABL       X'10' CMDENABL This CMDBK is
                                            enabled
              .... 1...      CMDSILNT       X'08' CMDSILNT Command may be
                                            silenced
              .... .1..      CMDNOUP        X'04' CMDNOUP Do not uppercase
                                            this command
              .... ..1.      CMDONLY        X'02' CMDONLY Only one version
                                            (IBMCLASS)
              .... ...1      CMDNOCL        X'01' CMDNOCL Command is class
                                            'ANY'
    002E   46 Bitstring    1 DCMPIFL1       CMDFLAG1
              1... ....      CMDPROC        X'80' CMDPROC Command processor
                                            performs further privilege class
                                            checks
              .1.. ....      CMDXLOG        X'40' CMDXLOG Command can be
                                            turned off prior to logon
              ..1. ....      CMDVPROT       X'20' CMDVPROT Command can be
                                            protected
              ...1 ....      CMDVMAC        X'10' CMDVMAC Command may be
                                            Mandatory Access Controlled
    002F   47 Bitstring    1 DCMPISC        CMDSECUR
              1... ....      CMDAUDIT       X'80' CMDAUDIT Command is to be
                                            audited
              .1.. ....      CMDPROT        X'40' CMDPROT Command is to be
                                            protected
              ..1. ....      CMDMAC         X'20' CMDMAC Command is to be
                                            Mandatory Access Controlled
    0030   48 Signed       4 *              Reserved
    0034   52 Signed       4 *              Reserved
    0038   56 Character 4016 DCMPIWRK       Work area to place stuff: - the
                                            command name, - the subcommand
                                            name, - the alias name, - and
                                            anything else.
              000001FD       DCMPISIZ       (*-DCMPI+7)/8 Max DCMPI size in
                                            dwords
              00000FE8       DCMPIBSZ       (*-DCMPI) Max DCMPI size in bytes

#### DCMPI Storage Layout

    *** DCMPI - Define Command Program Interface Plist
    *
    *     +-------------+-------------+---------------------------+
    *   0 |  DCMPIPLL   |/////////////|///////////////////////////|
    *     +-------------+-------------+-------------+-------------+
    *   8 |  DCMPICMO   |  DCMPICML   |  DCMPICMA   |/////////////|
    *     +-------------+-------------+-------------+-------------+
    *  10 |  DCMPISCO   |  DCMPISCL   |  DCMPISCA   |/////////////|
    *     +-------------+-------------+-------------+-------------+
    *  18 |  DCMPIALO   |  DCMPIALL   |/////////////|/////////////|
    *     +-------------+-------------+-------------+-------------+
    *  20 |                       DCMPIEPN                        |
    *     +------+------+------+------+------+------+------+------+
    *  28 |:PICL0|:PICL1|:PICL2|:PICL3|:PIIBM|:PIFL |:PIFL1|:PISC |
    *     +------+------+------+------+------+------+------+------+
    *  30 |///////////////////////////|///////////////////////////|
    *     +---------------------------+---------------------------+
    *  38 |                                                       |
    *     =                       DCMPIWRK                        =
    *     |                                                       |
    *     +-------------------------------------------------------+
    * FE8
    *
    *** DCMPI - Define Command Program Interface Plist

#### DCMPI Cross Reference

    Symbol         Dspl Value
    -------------- ---- -----
    CLASSA         0028 80
    CLASSALL       002B DCMPICL3
    CLASSB         0028 40
    CLASSC         0028 20
    CLASSD         0028 10
    CLASSE         0028 08
    CLASSF         0028 04
    CLASSG         0028 02
    CLASSH         0028 01
    CLASSI         0029 80
    CLASSJ         0029 40
    CLASSK         0029 20
    CLASSL         0029 10
    CLASSM         0029 08
    CLASSN         0029 04
    CLASSO         0029 02
    CLASSP         0029 01
    CLASSQ         002A 80
    CLASSR         002A 40
    CLASSS         002A 20
    CLASST         002A 10
    CLASSU         002A 08
    CLASSV         002A 04
    CLASSW         002A 02
    CLASSX         002A 01
    CLASSY         002B 80
    CLASSZ         002B 40
    CLASS1         002B 20
    CLASS2         002B 10
    CLASS3         002B 08
    CLASS4         002B 04
    CLASS5         002B 02
    CLASS6         002B 01
    CMDALIAS       002D 20
    CMDALOG        002D 80
    CMDAUDIT       002F 80
    CMDENABL       002D 10
    CMDMAC         002F 20
    CMDNOCL        002D 01
    CMDNOUP        002D 04
    CMDOLOG        002D 40
    CMDONLY        002D 02
    CMDPROC        002E 80
    CMDPROT        002F 40
    CMDSILNT       002D 08
    CMDVMAC        002E 10
    CMDVPROT       002E 20
    CMDXLOG        002E 40
    DCMPIALL       001A
    DCMPIALO       0018
    DCMPIBSZ       0038 00000FE8
    DCMPICLS       0028
    DCMPICL0       0028
    DCMPICL1       0029
    DCMPICL2       002A
    DCMPICL3       002B
    DCMPICMA       000C
    DCMPICML       000A
    DCMPICMO       0008
    DCMPIEPN       0020
    DCMPIFL        002D
    DCMPIFL1       002E
    DCMPIIBM       002C
    DCMPIIB0       002C 2C
    DCMPIPLL       0000
    DCMPISC        002F
    DCMPISCA       0014
    DCMPISCL       0012
    DCMPISCO       0010
    DCMPISIZ       0038 000001FD
    DCMPIWRK       0038

This information is based on z/VM V6R1.0. Last updated on 18 Feb 2010 at 08:32:28 EDT.
Copyright IBM Corporation, 1990, 2008