INQUIRE DOCTEMPLATE

Find out whether a DOCTEMPLATE is installed.

Read syntax diagramSkip visual syntax diagramINQUIRE DOCTEMPLATE
 
>>-INQUIRE DOCTEMPLATE(data-value)------------------------------>
 
   .-----------------------------.
   V                             |
>----+-------------------------+-+-----------------------------><
     +-APPENDCRLF(cvda)--------+
     +-DDNAME(data-area)-------+
     +-DSNAME(data-area)-------+
     +-EXITPGM(data-area)------+
     +-FILE(data-area)---------+
     +-HFSFILE(data-area)------+
     +-MEMBER(data-area)-------+
     +-PROGRAM(data-area)------+
     +-TDQUEUE(data-area)------+
     +-TEMPLATENAME(data-area)-+
     +-TEMPLATETYPE(cvda)------+
     +-TSQUEUE(data-area)------+
     '-TYPE(cvda)--------------'
 

Conditions: END, ILLOGIC, NOTFND, NOTAUTH

Start of changeThis command is threadsafe.End of change

Description

The INQUIRE DOCTEMPLATE command allows you to determine whether a particular DOCTEMPLATE is installed (defined in the current execution of your CICS system).

Browsing

You can also browse through all of the DOCTEMPLATE installed in your system by using the browse options (START, NEXT, and END) on INQUIRE DOCTEMPLATE commands. See Browsing resource definitions for general information about browsing, including syntax, exception conditions, and examples.

Options

APPENDCRLF(cvda)
returns a CVDA value identifying whether CICS is to delete trailing blanks from and append carriage-return line-feed to each logical record of the template. CVDA values are:
APPEND
delete trailing blanks from and append carriage-return line-feed to each logical record of the template.
NOAPPEND
do not delete trailing blanks from or append carriage-return line-feed to each logical record of the template.
DDNAME(data-value)
returns the DD name of the PDS containing the template. The DDName applies only to a template of type PDS.
DOCTEMPLATE(data-value)
specifies the 8-character identifier of the DOCTEMPLATE about which you are inquiring.
DSNAME(data-value)
returns the data set name of the PDS containing the template. It applies only to a template of type PDS.
EXITPGM(data-value)
returns the exit program to be invoked when a request is made for this template. The exit program is passed an architected commarea containing the address and length of a buffer into which the exit program returns the template.
FILE(data-value)
returns the 8-character name of the CICS file definition for the data set containing the template.
Start of changeHFSFILE(data-value) End of change
Start of changereturns the fully-qualified name of the z/OS UNIX System Services HFS file where the template resides. This can be up to 255 characters in length.End of change
MEMBER(data-value)
returns the name of the member in the PDS containing the template. MEMBER applies only to a template of type PDS.
PROGRAM(data-value)
returns the program in which the template data is stored. CICS loads the program and takes all data after the entrypoint to be the template.
TDQUEUE(data-value)
returns the name of the TD queue on which the template is stored.
TEMPLATENAME(data-value)
returns the extended template-name by which the doctemplate is to be known outside the resource definition function.
TEMPLATETYPE(cvda)
returns a CVDA value identifying the type of the source of this template. CVDA values are:
EXIT
an exit program.
FILE
a CICS file name for a data set.
Start of changeHFSFILEEnd of change
Start of changea z/OS UNIX System Services HFS file.End of change
PDSMEMBER
a name of the member in the PDS described in DDNAME.
PROGRAM
a name of a program.
TDQ
a name of a TD queue.
TSQ
a name of a TS queue.
TSQUEUE(data-value)
returns the name of the TS queue on which the template is stored.
TYPE(data-value)
returns a CVDA value identifying the format of the template contents. CVDA values are:
BINARY
EBCDIC

Conditions

END
RESP2 values:
2
There are no more resource definitions of this type.
ILLOGIC
RESP2 values:
1
You have issued a START command when a browse of this resource type is already in progress, or you have issued a NEXT or an END command when a browse of this resource type is not in progress.
NOTAUTH
RESP2 values:
100
The user associated with the issuing task is not authorized to use this command.
NOTFND
RESP2 values:
1
The DOCTEMPLATE specified cannot be found.
[[ Contents Previous Page | Next Page Index ]]