PGIS gate, START_BROWSE_PROGRAM function
The START_BROWSE_PROGRAM function of the PGIS gate is used to start browsing through program definitions, optionally starting at the given program definition.
Input Parameters
- AC_APPLICATION_NAME
- Optional parameter
- The 64-character name of the application associated with the program being inquired upon.
- AC_MAJOR_VERSION
- Optional parameter
- The fullword binary value that is the major version of the application associated with the program being inquired upon.
- AC_MINOR_VERSION
- Optional parameter
- The fullword binary value that is the minor version of the application associated with the program being inquired upon.
- AC_MICRO_VERSION
- Optional parameter
- The fullword binary value that is the micro version of the application associated with the program being inquired upon.
- AC_PLATFORM_NAME
- Optional parameter
- The 64-character name of the platform associated with the program being inquired upon.
- PROGRAM_NAME
- Optional Parameter
- The name of the program resource to be browsed.
- SHOW_PROGRAMS
- Optional Parameter
- This field is required if an application context is supplied using the fields beginning AC_. It specifies whether private programs only, or first private and then public programs, are searched.
- Values for the parameter are as follows:
- PRIVATE
- PRIVATE_AND_PUBLIC
- If this field is specified but no application context is supplied, an inquiry with PRIVATE_AND_PUBLIC searches only public programs, and an inquiry with PRIVATE returns a not found response.
- TASK_RELATED
- Optional Parameter
- Indicates whether the browse is task-related. If it is task-related, storage will be obtained from the CICS® storage class rather than the directory browse subpool. The default is YES.
- Values for the parameter are as follows:
- NO
- YES
Output Parameters
- REASON
- The following values are returned when RESPONSE is DISASTER:
- ABEND
- APP_CONTEXT_NOT_FOUND
- INVALID_DIRECTORY
- LOCK_ERROR
- The values for the parameter are:
- NO_REASON
- BROWSE_TOKEN
- A browse token that references a container in the container pool. This container is the first in the browse list.
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.