DHDH gate, INSERT_DATA function
The INSERT_DATA function of the DHDH gate is used to insert a block of data into an existing document.
Input Parameters
- BINARY
- is a buffer containing a block of binary data to be added to the document.
- DOCUMENT_TOKEN
- is the token which identifies the document into which the data will be inserted.
- INSERT_AT
- is the name of a bookmark which identifies the position at which the data should be inserted.
- INSERT_POINT
- identifies the beginning or end as the position at which data should be inserted into a document.
- RETRIEVED_DOCUMENT
- is a buffer containing a document in a retrieved format which is to be added to the document.
- SOURCE_DOCUMENT
- is the document token of an existing document created by the same CICS task which is to be added to the document.
- SYMBOL
- is the name of a symbol defined in the symbol table. The value associated with the symbol will be added to the document.
- TEMPLATE_BUFFER
- is a buffer containing a template to be added to the document.
- TEMPLATE_NAME
- is the name of an RDO defined DOCTEMPLATE which is to be added to the document.
- TEXT
- is a buffer containing a block of text 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
- 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.
Output Parameters
- REASON
- The values for the parameter are:
- CODEPAGE_NOT_SPECIFIED
- DOCUMENT_NOT_FOUND
- EMBED_DEPTH_EXCEEDED
- INSERTPOINT_NOT_FOUND
- INVALID_HOST_CODEPAGE
- INVALID_RETRIEVE_FORMAT
- INVALID_TEMPLATE_LENGTH
- INVALID_TEMPLATE_SYNTAX
- IO_ERROR
- SOURCE_DOC_NOT_FOUND
- SYMBOL_NOT_FOUND
- TEMPLATE_NOT_FOUND
- TEMPLATE_NOT_USABLE
- 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.
- RETRIEVE_SIZE
- is the maximum size in bytes that a retrieved copy of the document can be.