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

#### CSPBK

Prolog

Control Block Contents
CSPBK DSECT

Storage Layout

Cross Reference (Contains links to field and bit definitions)

#### CSPBK Prolog

     NAME       : HCPCSPBK
     DESCRIPTION: SPOOL Command Communications Block
     DSECT      : CSPBK
     FUNCTION   : Hold the results of SPOOL command parsing
                  to pass to the SPOOL processor.
     LOCATED BY : Based on R4 in HCPCSP and HCPSPL
     CREATED BY : HCPCSP - Call HCPGETST
     DELETED BY : HCPSPL - Call HCPRELST

#### CSPBK Control Block Content

#### CSPBK DSECT

    Hex   Dec Type/Val   Lng Label (dup)    Comments
    ---- ---- --------- ---- -------------- --------
    0000    0 Structure      CSPBK          SPOOL Command Communications
                                            Block
    0000    0 Signed       4 CSPSCANP (0)   Vdev scan parameters for HCPSCNVT
    0000    0 Bitstring    2 CSPSCDEV       Current device (X'FFFF' to start)
    0002    2 Bitstring    1 CSPSCNCL       Class = SPOOL
    0003    3 Bitstring    1 CSPSCTYP       Type = RDR, PRT, PUN
    0004    4 Bitstring    1 CSPSETON       'Set option ON' flag - SOT defs
              1... ....      SOTHOLD        X'80' HOLD OR NOHOLD OPTION
              .1.. ....      SOTKEEP        X'40' KEEP OR NOKEEP OPTION
              ..1. ....      SOTMSG         X'20' MSG OR NOMSG OPTION
              ...1 ....      SOTCONT        X'10' CONT OR NOCONT OPTION
              .... 1...      SOTEOF         X'08' EOF OR NOEOF OPTION NOTE:
                                            IT ALSO USED FOR SYS OR NOSYS
                                            OPTION
              .... .1..      SOTNAME        X'04' NAME OR NONAME OPTION
              .... ..1.      SOTTERM        X'02' TERM OR NOTERM OPTION
              .... ...1      SOTSTART       X'01' START OR STOP OPTION
    0005    5 Bitstring    1 CSPSETOF       'Set option OFF' flag - SOT defs
    0006    6 Bitstring    1 CSPFLAG        Parsing and processing flags
              1... ....      CSPSPECV       X'80' Specific vdev to SPOOL
              .1.. ....      CSP1DONE       X'40' At least 1 vdev processed
              ..1. ....      CSPPURGE       X'20' PURGE active files
              ...1 ....      CSPCLOSE       X'10' CLOSE active files
              .... .1..      CSPCHARA       X'04' CHARS option in progress
              .... ..1.      CSPFORSP       X'02' 'FOR' OPTION SPECIFIED
              .... ...1      CSPASYNC       X'01' Close files asynchronously
    0007    7 Bitstring    1 CSPOPFLG       Options specified flag
              1... ....      CSPFCBF        X'80' FCB option specified
              .1.. ....      CSPMODF        X'40' MODIFY option specified
              ..1. ....      CSPCHARF       X'20' CHARS option specified
              ...1 ....      CSPFLSHF       X'10' FLASH option specified
              .... 1...      CSPFLALL       X'08' Flash all copies
              .... .1..      CSPPGCPY       X'04' Page copy option specified
              .... ..1.      CSPDISTF       X'02' DIST option specified
              .... ...1      CSPOFFF        X'01' OFF option specified
    0008    8 Bitstring    1 CSPNTYP        New device type - SPOOL TO or FOR
    0009    9 Bitstring    1 CSPCOPY        New copy (or page-copy) count
    000A   10 Bitstring    1 CSPFLCNT       New flash count
    000B   11 Bitstring    1 CSPMODNM       New modify number
    000C   12 Bitstring    1 CSPSTON1       'Set option ON' flag - SOT defs
              1... ....      SOTRSCN        X'80' RESCAN/NORESCAN specified
    000D   13 Bitstring    1 CSPSTOF1       'Set option OFF' flag - SOT defs
    000E   14 Bitstring    1 *              Reserved for IBM use
    000F   15 Character    1 CSPBLANK (0)   Fields to initialize to blanks
    000F   15 Character    1 CSPCLASS       New spool file class
    0010   16 Character    8 CSPOWNER       New file ownerid
    0018   24 Character    8 CSPFORM        New form name
    0020   32 Character    8 CSPOFORM       Corresponding operator form numbr
    0028   40 Character    8 CSPDIST        New distribution code
    0030   48 Character    8 CSPDEST        New destination value
    0038   56 Character    8 CSPFNAME       New filename
    0040   64 Character    8 CSPFTYPE       New filetype
    0048   72 Character    4 CSPFLASH       New flash name
    004C   76 Character    4 CSPFCB         New fcb name
    0050   80 Character    4 CSPCMOD        New copy modification name
    0054   84 Character   16 CSPCHARS (0)   All four character names
    0054   84 Character    4 CSPCHAR0       New character set name (first)
    0058   88 Character    4 CSPCHAR1       New character set name (second)
    005C   92 Character    4 CSPCHAR2       New character set name (third)
    0060   96 Character    4 CSPCHAR3       New character set name (fourth)
              00000054       CSPBLKLN       *-CSPBLANK-1 For clearing char
                                            fields to blank
    0064  100 Bitstring    1 CSPFLAG2       Parsing and processing flags
              1... ....      CSPLPPF        X'80' Virtual LPP specified
    0065  101 Address      1 CSPVLPP        New virtual LPP value
    0066  102 Bitstring    1 *              Reserved for IBM use
    0067  103 Bitstring    1 *              Reserved for IBM use
    0068  104 Signed       4 CSPDEVOP (2)   Length and address of dev operand
    0070  112 Character    8 CSPTARG        Target group name
              0000000F       CSPSIZE        (*-CSPBK+7)/8 Size in doublewords

#### CSPBK Storage Layout

    *** CSPBK - SPOOL Command Communications Block
    *
    *     +-------------+------+------+------+------+------+------+
    *   0 |  CSPSCDEV   |:SCNCL|:SCTYP|:SETON|:SETOF|:FLAG |:OPFLG|
    *     +------+------+------+------+------+------+------+------+
    *   8 |:NTYP |:COPY |:FLCNT|:MODNM|:STON1|:STOF1|//////|:CLASS|
    *     +------+------+------+------+------+------+------+------+
    *  10 |                       CSPOWNER                        |
    *     +-------------------------------------------------------+
    *  18 |                       CSPFORM                         |
    *     +-------------------------------------------------------+
    *  20 |                       CSPOFORM                        |
    *     +-------------------------------------------------------+
    *  28 |                       CSPDIST                         |
    *     +-------------------------------------------------------+
    *  30 |                       CSPDEST                         |
    *     +-------------------------------------------------------+
    *  38 |                       CSPFNAME                        |
    *     +-------------------------------------------------------+
    *  40 |                       CSPFTYPE                        |
    *     +---------------------------+---------------------------+
    *  48 |         CSPFLASH          |          CSPFCB           |
    *     +---------------------------+---------------------------+
    *  50 |         CSPCMOD           |         CSPCHAR0          |
    *     +---------------------------+---------------------------+
    *  58 |         CSPCHAR1          |         CSPCHAR2          |
    *     +---------------------------+------+------+------+------+
    *  60 |         CSPCHAR3          |:FLAG2|:VLPP |//////|//////|
    *     +---------------------------+------+------+------+------+
    *  68 |                       CSPDEVOP                        |
    *     +-------------------------------------------------------+
    *  70 |                       CSPTARG                         |
    *     +-------------------------------------------------------+
    *  78
    *
    *** CSPBK - SPOOL Command Communications Block

#### CSPBK Cross Reference

    Symbol         Dspl Value
    -------------- ---- -----
    CSPASYNC       0006 01
    CSPBLANK       000F
    CSPBLKLN       0060 00000054
    CSPCHARA       0006 04
    CSPCHARF       0007 20
    CSPCHARS       0054
    CSPCHAR0       0054
    CSPCHAR1       0058
    CSPCHAR2       005C
    CSPCHAR3       0060
    CSPCLASS       000F
    CSPCLOSE       0006 10
    CSPCMOD        0050
    CSPCOPY        0009
    CSPDEST        0030
    CSPDEVOP       0068
    CSPDIST        0028
    CSPDISTF       0007 02
    CSPFCB         004C
    CSPFCBF        0007 80
    CSPFLAG        0006
    CSPFLAG2       0064
    CSPFLALL       0007 08
    CSPFLASH       0048
    CSPFLCNT       000A
    CSPFLSHF       0007 10
    CSPFNAME       0038
    CSPFORM        0018
    CSPFORSP       0006 02
    CSPFTYPE       0040
    CSPLPPF        0064 80
    CSPMODF        0007 40
    CSPMODNM       000B
    CSPNTYP        0008
    CSPOFFF        0007 01
    CSPOFORM       0020
    CSPOPFLG       0007
    CSPOWNER       0010
    CSPPGCPY       0007 04
    CSPPURGE       0006 20
    CSPSCANP       0000
    CSPSCDEV       0000
    CSPSCNCL       0002
    CSPSCTYP       0003
    CSPSETOF       0005
    CSPSETON       0004
    CSPSIZE        0070 0000000F
    CSPSPECV       0006 80
    CSPSTOF1       000D
    CSPSTON1       000C
    CSPTARG        0070
    CSPVLPP        0065
    CSP1DONE       0006 40
    SOTCONT        0004 10
    SOTEOF         0004 08
    SOTHOLD        0004 80
    SOTKEEP        0004 40
    SOTMSG         0004 20
    SOTNAME        0004 04
    SOTRSCN        000C 80
    SOTSTART       0004 01
    SOTTERM        0004 02

This information is based on z/VM V5R2.0. Last updated on 12 Apr 2006 at 16:47:03 EDT.
Copyright IBM Corporation, 1990, 2005