DHTM gate, INQUIRE_DOCTEMPLATE function

The INQUIRE_DOCTEMPLATE function of the DHTM gate returns information about a previously installed document template.

Input Parameters

DOCTEMPLATE
is the name of the DOCTEMPLATE resource that is to be added.

Output Parameters

REASON
The following values are returned when RESPONSE is DISASTER:
  • ABEND
  • DIRECTORY_ERROR
  • LOOP
The following values are returned when RESPONSE is EXCEPTION:
  • BROWSE_END
  • DDNAME_NOT_FOUND
  • FREEMAIN_FAILED
  • GETMAIN_FAILED
  • IO_ERROR
  • MEMBER_NOT_FOUND
  • NAME_IN_USE
  • NOT_FOUND
  • NOT_USABLE
  • TRUNCATED
The following values are returned when RESPONSE is INVALID:
  • INVALID_BROWSE_TOKEN
  • INVALID_FORMAT
  • INVALID_FUNCTION
  • INVALID_RESOURCE_TYPE
APPENDCRLF
specifies whether CICS® is to delete trailing blanks from and append carriage-return line-feed to each logical record of the template .
Values for the parameter are:
  • NO
  • YES
DATASET
is the data set name of the PDS containing the DOCTEMPLATE resource if the resource resides on a PDS.
DDNAME
is the DDNAME of the template PDS if the RESOURCE_TYPE indicates a PDS.
HFSPATH
When the template resides in a z/OS® UNIX System Services file, the fully qualified (absolute) or relative name of the z/OS UNIX file.
RESOURCE_NAME
is the name of the CICS or non-CICS resource.
RESOURCE_TYPE
is the CICS or non-CICS resource type associated with the template.
Values for the parameter are:
  • EXITPGM
  • FILE
  • HFSFILE
  • PDS_MEMBER
  • PROGRAM
  • TDQUEUE
  • TSQUEUE
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
TEMPLATE_NAME
is the full name of the template as known outside RDO.
TYPE
specifies the format of the contents of the template.
Values for the parameter are:
  • BINARY
  • EBCDIC


dfhs3_DHTMinquire_doctemplate.html | Timestamp icon Last updated: Monday, 5 June 2017