z/OS DFSMS OAM Application Programmer's Reference
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


STOREBEG—Beginning a Store Sequence operation

z/OS DFSMS OAM Application Programmer's Reference
SC23-6865-00

A Store Sequence operation begins with STOREBEG, which provides much of the same information that is provided on a STORE. See the description of OSREQ STORE for the description of keyword parameters. For STOREBEG, no buffers with object data are provided and therefore no keyword parameters related to these buffers are allowed. A store token (STOKEN) is provided as an output so an area to return this new store token must be provided. This store token must be provided on the subsequent STOREPRT and STOREEND functions. The size specified on STOREBEG is the total object size, which is required for OAM to acquire resources necessary to store the complete object. STOREBEG, STOREPRT, and STOREEND cannot be used for objects less than or equal to 50 megabytes, nor can they be used for optical volumes.. Every STOREBEG request must have a corresponding STOREEND request.

Also see Processing a store to a new collection and Processing a store to an existing collection. Note that during a store sequence, collection related processing is only performed for the OSREQ STOREBEG request and there is no additional interaction with the MVS catalog or ACS routines during OSREQ STOREPRT or OSREQ STOREEND requests.

Figure 1. Conceptual view of a Store Sequence operation
Conceptual view of a Store Sequence operation
Read syntax diagramSkip visual syntax diagram
Syntax for OSREQ STOREBEG

>>-OSREQ STOREBEG--MF=-+-L---------------------------------+---->
                       +-(M,parameter_list-+-----------+-)-+   
                       |                   '-,COMPLETE-'   |   
                       '-(E,parameter_list-+-----------+-)-'   
                                           '-,COMPLETE-'       

>--+-------------------------------------+---------------------->
   |       (1)                           |   
   '-TOKEN----=-+-token_area-----------+-'   
                '-(token_area_pointer)-'     

>--+---------------------------------------+-------------------->
   |        (1)                            |   
   '-STOKEN----=-+-store_token-----------+-'   
                 '-(store_token_pointer)-'     

>--+--------------------------------------------------+--------->
   |          (1)                                     |   
   '-COLLECTN----=-+-collection_name_area-----------+-'   
                   '-(collection_name_area_pointer)-'     

>--+------------------------------------------+----------------->
   |      (1)                                 |   
   '-NAME----=-+-object_name_area-----------+-'   
               '-(object_name_area_pointer)-'     

>--+-----------------------------------------+------------------>
   |      (1) (2)                            |   
   '-SIZE--------=-+-object_byte-----------+-'   
                   '-(object_byte_pointer)-'     

>--+--------------------------------------------+--------------->
   '-STORCLAS=-+-storage_class_area-----------+-'   
               '-(storage_class_area_pointer)-'     

>--+-----------------------------------------------+------------>
   '-MGMTCLAS=-+-management_class_area-----------+-'   
               '-(management_class_area_pointer)-'     

>--+---------------------------------------+-------------------->
   '-RETPD=-+-retention_period-----------+-'   
            '-(retention_period_pointer)-'     

>--+-------------------------------------+---------------------->
   '-MSGAREA=-+-message_area-----------+-'   
              '-(message_area_pointer)-'     

>--+------------------------------------+----------------------->
   '-RETCODE=-+-return_code-----------+-'   
              '-(return_code_pointer)-'     

>--+------------------------------------+----------------------->
   '-REACODE=-+-reason_code-----------+-'   
              '-(reason_code_pointer)-'     

>--+--------------------------------------+--------------------->
   '-TTOKEN=-+-tracking_token-----------+-'   
             '-(tracking_token_pointer)-'     

>--+----------------------------------+------------------------->
   '-STIMEOUT=-+-stimeout-----------+-'   
               '-(stimeout_pointer)-'     

>--+---------------------------+-------------------------------><
   |         (3)               |   
   '-DELHOLD----=-+-HOLD-----+-'   
                  '-(NOHOLD)-'     

Notes:
  1. These keywords are required and therefore they must be specified on the MF=E form if it indicates COMPLETE or they must be specified on at least one of the forms if the MF=E does not indicate COMPLETE.
  2. The size specified must be the exact total size of the object.
  3. If DELHOLD is not specified, the default value is DELHOLD=NOHOLD.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014