The start_browse_program call – IBM SC34-6814-04 User Manual

Page 401

Advertising
background image

The START_BROWSE_PROGRAM call

START_BROWSE_PROGRAM returns a token that enables you to begin browsing
through program definitions, optionally starting at the definition of a specified
program.

START_BROWSE_PROGRAM

DFHPGISX [CALL,]

[CLEAR,]
[IN,
FUNCTION(START_BROWSE_PROGRAM),
[PROGRAM_NAME(name8 | string | ’string’),]]
[OUT,
BROWSE_TOKEN(name4)
RESPONSE(name1 | *),
REASON(name1 | *)]

This command is threadsafe.

BROWSE_TOKEN(name4)

returns a token to be used on a GET_NEXT_PROGRAM call, to initiate a
sequential browse of program definitions.

name4

The name of a location to receive a 4-byte token.

PROGRAM_NAME(name8 | string | 'string')

specifies the name of the program whose definition you want to look at first.
The browsing sequence is alphabetical. If there is no program with the specified
name, CICS returns a token for the next definition in the alphabetic sequence. If
you do not specify a program, CICS returns a token for the first definition.

name8

The name of a location containing an 8-byte program name.

string A string of characters naming the program.

'string'

A string of characters in quotation marks. The string length is set to 8
by padding with blanks or truncating.

RESPONSE and REASON values for
START_BROWSE_PROGRAM:

RESPONSE

REASON

OK

None

EXCEPTION

None

DISASTER

ABEND
INVALID_DIRECTORY
LOCK_ERROR

INVALID

None

KERNERROR

None

PURGED

None

Chapter 3. The user exit programming interface (XPI)

379

Advertising