snmpEntityToStr 函数 (winsnmp.h)
[SNMP 可用于“要求”部分中指定的操作系统。 它可能在后续版本中变更或不可用。 请改用 Windows 远程管理,这是 WS-Man 的 Microsoft 实现。]
WinSNMP SnmpEntityToStr 函数返回标识 SNMP 管理实体的字符串。
语法
SNMPAPI_STATUS SNMPAPI_CALL SnmpEntityToStr(
[in] HSNMP_ENTITY entity,
[in] smiUINT32 size,
[out] LPSTR string
);
参数
[in] entity
感兴趣的 SNMP 管理实体的句柄。
[in] size
指定 字符串 参数指向的缓冲区的大小(以字节为单位)。 WinSNMP 应用程序必须分配足以包含输出字符串的缓冲区。
[out] string
指向缓冲区的指针,用于接收以 null 结尾的字符串,该字符串标识感兴趣的 SNMP 管理实体。
返回值
如果函数成功,则返回值是 SnmpEntityToStr 在 字符串 缓冲区中返回的字节数,包括终止 null 字节。 此值可以小于或等于 size 参数的值,但不能大于该值。
如果函数失败,则返回值SNMPAPI_FAILURE。 若要获取扩展的错误信息,请调用 SnmpGetLastError。 SnmpGetLastError 函数可能会返回以下错误之一。
返回代码 | 说明 |
---|---|
|
SnmpStartup 函数未成功完成。 |
|
内存分配期间出错。 |
|
实体参数无效。 |
|
输出缓冲区长度不足。 |
|
发生未知或未定义的错误。 |
注解
实体和上下文转换模式的当前设置确定输出字符串 SnmpEntityToStr 返回的类型。 有关详细信息,请参阅 WinSNMP 中对 IPX 地址字符串的支持 和 设置实体和上下文转换模式。
当实体和上下文转换模式SNMPAPI_TRANSLATED,并且实现的数据库中存在条目时,实现将返回管理实体的关联用户友好名称。 如果管理实体的条目不存在, SnmpEntityToStr 将返回管理实体的文本 SNMP 传输地址。
当实体和上下文转换模式SNMPAPI_UNTRANSLATED_V1或SNMPAPI_UNTRANSLATED_V2时,Microsoft WinSNMP 实现还会返回管理实体的文本 SNMP 传输地址。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows 2000 Professional [仅限桌面应用] |
最低受支持的服务器 | Windows 2000 Server [仅限桌面应用] |
目标平台 | Windows |
标头 | winsnmp.h |
Library | Wsnmp32.lib |
DLL | Wsnmp32.dll |