Extract_CPIC_Side_Information调用(函数名称 xcmesi)返回条目号或符号目标名称的侧信息。
语法
CM_ENTRY Extract_CPIC_Side_Information(
CM_INT32 FAR *entry_number,
unsigned char FAR *sym_dest_name,
SIDE_INFO FAR *side_info_entry,
CM_INT32 FAR *side_info_entry_length,
CM_INT32 FAR *return_code
);
参数
entry_number
提供的参数。 指定要返回的侧信息项的数字(索引)。 第一个条目为 1。
程序可以改为按符号目标名称查找侧信息条目。 为此,请将条目编号设置为零。
sym_dest_name
提供的参数。 指定要搜索的符号目标名称。
如果 entry_number 设置为大于零的数字,则忽略此参数。
side_info_entry
返回的参数。 指定侧信息条目。 有关侧信息条目的详细说明,请参阅 Set_CPIC_Side_Information。
侧信息结构中的每个字段都是左对齐的,并根据需要用右侧的空格填充。
side_info_entry_length
提供的参数。 始终为 124。
return_code
从此调用返回的代码。 本主题后面列出了有效的返回代码。
返回代码
CM_OK
主要返回代码;调用已成功执行。
CM_PROGRAM_PARAMETER_CHECK
主要返回代码;发生以下事件之一:
entry_number指定的数字大于侧信息表中的最大条目数或小于零的数字。
sym_dest_name参数无效,entry_number设置为零。
side_info_entry_length参数未设置为 124。
CM_PRODUCT_SPECIFIC_ERROR
主要返回代码;发生了特定于产品的错误,并且已记录在产品错误日志中。
状态更改
此调用不与对话关联,并且可能处于任何状态。
没有状态更改。
注解
永远不会返回安全密码。 如果未设置侧信息中的安全用户标识符,则安全用户标识符字段将作为所有空格返回。