STARTBROWSE CONTAINER

Start a browse of the containers associated with Start of changea channelEnd of change, or with a BTS activity or process. Start of changeAlthough this command appears in the Application Programming set of topics, to use it you must specify the system programming (SP) parameter in the EXEC statement of the translate step of your compile job. See Technote 1265081 for further information.End of change

Start of change
Read syntax diagramSkip visual syntax diagram
STARTBROWSE CONTAINER

>>-STARTBROWSE--CONTAINER--------------------------------------->

>--+----------------------------------------------+------------->
   +-ACTIVITYID(data-value)-----------------------+   
   +-PROCESS(data-value)--PROCESSTYPE(data-value)-+   
   '-CHANNEL(data-value)--------------------------'   

>--BROWSETOKEN(data-area)--------------------------------------><

Conditions: ACTIVITYERR, Start of changeCHANNELERR, End of changeIOERR, NOTAUTH, PROCESSERR

End of change

Description

Start of changeSTARTBROWSE CONTAINER initializes a browse token which can be used to identify the name of each data-container associated with a specified channel, or with a BTS activity or process.
Note: Start of changeThe browse token should be used only by the program that issues the STARTBROWSE command.End of change
End of change

Start of changeIf you specify none of the ACTIVITYID, PROCESS, or CHANNEL options, CICS examines the context (channel or BTS) of the request. If a current channel exists, its containers are browsed. If a current activity exists, its containers are browsed. If neither exists, an ACTIVITYERR 2 is raised: see the description of the ACTIVITYERR condition, below.End of change

Options

ACTIVITYID(data-value)
specifies the identifier (1–52 characters) of the activity whose containers are to be browsed.

Typically, the identifier specified on this option has been returned on a previous GETNEXT ACTIVITY command.

BROWSETOKEN(data-area)
specifies a fullword binary data area, into which CICS® will place the browse token.
Start of changeCHANNEL(data-value)End of change
Start of changespecifies the name (1–16 characters) of the channel whose containers are to be browsed. This must be the name of either the current channel or of a channel created by the program that issues the STARTBROWSE CONTAINER command.

If this option is not specified, and the current context is channel, the current channel's containers are browsed.

Start of changeThe order in which containers are returned is undefined.End of change

End of change
PROCESS(data-value)
specifies the name (1–36 characters) of the process whose containers are to be browsed.
Note: The containers associated with a process (process containers) are globally available throughout the process. They are not the same as the root activity's containers.
PROCESSTYPE(data-value)
specifies the process-type (1–8 characters) of the process named on the PROCESS option.

Conditions

ACTIVITYERR
RESP2 values:
1
The activity indicated by the ACTIVITYID option could not be found.
Start of change2End of change
Start of changeNone of the ACTIVITYID, PROCESS, or CHANNEL options were specified and there is no current channel and no current activity associated with the request.End of change
29
The repository file is unavailable.
30
An input/output error has occurred on the repository file.
Start of changeCHANNELERREnd of change
Start of changeRESP2 values:
2
The channel specified on the CHANNEL option could not be found.
End of change
IOERR
RESP2 values:
30
An input/output error has occurred on the repository file.
NOTAUTH
RESP2 values:
101
The user associated with the issuing task is not authorized to access this resource in the way requested.
PROCESSERR
RESP2 values:
3
The process specified on the PROCESS option could not be found.
4
The process-type specified on the PROCESSTYPE option could not be found.
13
The request timed out. It may be that another task using this process-record has been prevented from ending.