DHSL gate, SET_SYMBOL_VALUE_BY_API function
The SET_SYMBOL_VALUE_BY_API function of the DHSL gate is used to set the value of a symbol in the symbol table. If the symbol does not exist in the table, it will be added. If the symbol does exist in the table, it will always be replaced.
Input Parameters
- DOCUMENT_TOKEN
- is the token which identifies the document into which the data will be inserted.
- SYMBOL_NAME
- is the name of the symbol in the symbol table.
- VALUE
- is the value to be associated with the symbol.
- PRIVATE_DATA
- Optional Parameter
- indicates that the symbol value is private, and should not be exposed in trace records.
- Values for the parameter are:
- NO
- YES
- 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:
- DOCUMENT_NOT_FOUND
- FREEMAIN_ERROR
- GETMAIN_ERROR
- INVALID_LENGTH
- SYMBOL_NAME_INVALID
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.