DOCUMENT SET
向符号表添加符号和值。
语法
条件: INVREQ , REGERR , NOTFND 和 SYMBOL
此命令是线程安全的。
NOHANDLE、RESP 和 RESP2是常用选项,可添加到所有 EXEC CICS 命令中以处理错误条件。 命令语法图和选项说明中没有明确包含这些选项。 有关这些常用选项和 EXEC CICS 命令语法的信息,请参阅 EXEC CICS 命令格式和编程注意事项.
描述
DOCUMENT SET 允许应用程序向符号表添加符号及其关联值。 如果要添加的符号已存在于表中,那么会将其替换为新定义。
注:
- 当包含符号的模板已插入到文档中时,您无法更改正在组成的文档中那些符号的替代值。 如果为符号设置不同的值,那么下次将模板插入文档时将使用新值。 您的更改不会影响已插入到文档中的值。
- 如果在设置模板中包含的符号之前插入模板,那么将永远不会替换这些符号。 如果根据模板创建文档而不指定符号列表,那么可能会发生此情况。
选项
- DELIMITER (数据值)
- 指定用于对 SYMBOL 列表缓冲区中的符号名称/值对进行定界的可选 1–byte 值。 If this option is not specified, the value defaults to an ampersand. 不允许使用某些定界符值 (例如,空格字符) ,如果使用了这些值,那么所有这些值都会导致命令上的 INVREQ 条件。 它们在 用于指定符号和符号列表的规则中列出。
如果使用此选项,那么应用程序必须确保 DELIMITER 不会出现在符号列表缓冲区中的任何符号值中。 因此,应用程序不应使用字母数字和其他可打印字符作为 DELIMITER 值。
- DOCTOKEN (data-area)
- 指定拥有符号表的文档的 16 字节二进制令牌。
- LENGTH (data-value)
- 指定包含与符号相关联的数据值的缓冲区的长度 (作为全字二进制值) ,或指定使用 SYMBOL 列表选项时包含符号列表的缓冲区的长度。
- SYMBOL (名称)
- 指定要添加到表中的符号的名称。 名称的长度可以是 1 到 32 个字符,并且没有嵌入的空格。 用于指定符号和符号列表的规则 列出了在指定符号名称时适用的规则。 如果要在同一命令中定义多个符号,请改为使用 SYMBOL 列表选项。
- SYMBOL 列表 (data-area)
- 指定包含符号列表的缓冲区。 使用 LENGTH 选项指定此缓冲区的长度。 A symbol list is a character string consisting of one or more symbol definitions separated by ampersands. 每个符号定义都由名称,等号和值组成。以下是符号列表的示例:
By default, symbols in the symbol list are separated by the & character, but you can override this by using the DELIMITER keyword to specify a different symbol separator. 用于指定符号和符号列表的规则 列出了使用 SYMBOL 列表设置符号时适用的规则。applid=IYCQ&jobname=test - 未转义
- 阻止 CICS® 取消对 SYMBOL 列表缓冲区中包含的符号值进行转义。 如果使用此选项,那么加号不会转换为空格,并且 %2B 之类的序列不会转换为单字节值。
UN转义选项不允许您在符号列表中的符号值内包含已用作符号分隔符的字符。 如果要使用UN转义选项,请选择永远不会在符号值中使用的符号分隔符。 或者,可以使用 SYMBOL 和 VALUE 选项来指定包含用作符号分隔符的字符的符号值,因为在 VALUE 选项中使用符号分隔符时没有特殊含义。
- VALUE (data-area)
- 指定包含要与 SYMBOL 关联的值的区域。 用于指定符号和符号列表的规则 列出了在指定符号值时适用的规则。
条件
- 16 INVREQ
- RESP2 值:
- 8
- 为 DELIMITER 指定的值无效。
- 22 LENGERR
- RESP2 值:
- 9
- 为符号列表 LENGTH 指定的值无效。 值必须介于 1 与 (16M -1) 之间。
- 10
- 为符号值 LENGTH 指定的值无效。 值必须介于 1 与 (16M -1) 之间。
- 13 NOTFND
- RESP2 值:
- 1
- 未创建文档或未正确指定名称。
- 116 符号
- 符号名称无效。 RESP2 值:
- 0
- 未使用 SYMBOL 列表。
- 偏移量
- RESP2 包含列表中无效符号的偏移量。
