DHDH gate, CREATE_DOCUMENT function
The CREATE_DOCUMENT function of the DHDH gate is used to create a new CICS document.
Input Parameters
- BINARY
- Optional Parameter
- is a buffer containing a block of binary data to be added to the document.
- HOST_CODEPAGE
- Optional Parameter
- is the character encoding for the block of data being added to the document. This parameter is taken into account for the TEXT and TEMPLATE_BUFFER options and ignored for all other options.
- PRIVATE_DATA
- Optional Parameter
- indicates that the block of data is private, and should not be exposed in trace records.
- Values for the parameter are:
- NO
- YES
- RETRIEVED_DOCUMENT
- Optional Parameter
- is a buffer containing a document in a retrieved format which is to be added to the document.
- SOURCE_DOCUMENT
- Optional Parameter
- is the document token of an existing document created by the same CICS task which is to be added to the document.
- SYMBOL_DELIMITER
- Optional Parameter
- is the character used to delimit symbol name-value pairs.
- SYMBOL_LIST
- Optional Parameter
- is a buffer containing a list of symbols to be added to the symbol table of the document.
- TEMPLATE_BUFFER
- Optional Parameter
- is a buffer containing a template to be added to the document.
- TEMPLATE_IN_ERROR
- Optional Parameter
- is a buffer which is used by the Document Handler domain to return the name of a DOCTEMPLATE in which an error has been detected. This parameter is only meaningful when specified with the TEMPLATE_NAME option or the TEMPLATE_BUFFER option where the template in the TEMPLATE_BUFFER option contains an embedded template.
- TEMPLATE_NAME
- Optional Parameter
- is the name of an RDO defined DOCTEMPLATE which is to be added to the document.
- TEXT
- Optional Parameter
- is a buffer containing a block of text to be added to the document.
- UNESCAPED_DATA
- Optional Parameter
- indicates if CICS should unescape symbol values in the data.
- Values for the parameter are:
- NO
- YES
Output Parameters
- REASON
- The values for the parameter are:
- CODEPAGE_NOT_SPECIFIED
- EMBED_DEPTH_EXCEEDED
- INVALID_HOST_CODEPAGE
- INVALID_RETRIEVE_FORMAT
- INVALID_SYMBOL_LIST_LENGTH
- INVALID_TEMPLATE_LENGTH
- INVALID_TEMPLATE_SYNTAX
- IO_ERROR
- SOURCE_DOC_NOT_FOUND
- SYMBOL_NAME_INVALID
- SYMBOL_VALUE_INVALID
- TEMPLATE_NOT_FOUND
- TEMPLATE_NOT_USABLE
- DOCUMENT_TOKEN
- is the token identifying the newly created document.
- ERROR_OFFSET
- is the offset into a template where a syntax error has been detected.
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
- DOCUMENT_SIZE
- Optional Parameter
- is the size of the data in a document.
- RETRIEVE_SIZE
- Optional Parameter
- is the maximum size in bytes that a retrieved copy of the document can be.