cniGetAttributeName2

该函数返回由索引指定的节点属性的名称。当代理需要由节点的特殊实例支持的属性名称时由消息代理调用它。函数必须保证按已知的、定义了的顺序返回,并返回由索引参数表示的属性名。

如果执行了 cniGetAttributeNamecniGetAttributeName2,则 cniDefineNodeClass 和 CCI_INV_IMPL_FUNCTION 失败。

在其中定义 类型 成员
CNI_VFT 可选 iFpGetAttributeName2

语法

CciSize cniGetAttributeName2(
  int          returnCode,
    CciContext* context,                
    int          index,
    CciChar*    buffer,
    int          bufsize);

参数

context
节点实例上下文的地址,由节点创建并由 cniCreateNodeContext 函数(输入)返回。
returnCode(输出)
int 指针。返回时,节点应该确保该 int 存储描述完成状态的值。可能的返回码是:
  • CCI_SUCCESS
  • CCI_ATTRIBUTE_UNKNOWN
  • CCI_BUFFER_TOO_SMALL
index
指定属性名的索引(输入)。从零开始的属性的索引。
buffer
其内复制属性名的缓冲区的地址(输出)。
bufsize
buffer 参数(输入)中指定的缓冲区的长度(以 CciChar 为单位)。

返回值

  • 如果成功,将属性名复制到所提供的缓冲区并返回复制的 CciChar 字符数。
  • 如果缓冲区的大小不足以包含属性名,则 returnCode 设置为 CCI_BUFFER_TOO_SMALL,并且返回需要的 CciChar 数。
  • 如果到达属性列表的末端并且未找到属性名,则 returnCode 设置成 CCI_ATTRIBUTE_UNKNOWN。例如,当 index 大于 n-1 时,其中 n 是该节点的属性个数。
声明 | 商标 | 下载 | 书库 | 支持 | 反馈
Copyright IBM Corporation 1999, 2006 最后一次更新时间:2006/08/14
as24699_