SnmpGetVb 函数 (winsnmp.h)
[SNMP 可用于“要求”部分中指定的操作系统。 它可能在后续版本中变更或不可用。 请改用 Windows 远程管理,这是 WS-Man 的 Microsoft 实现。]
WinSNMP 应用程序调用 SnmpGetVb 函数以从变量绑定列表中检索信息。 此 WinSNMP 函数从 index 参数指定的变量绑定项检索变量名称及其关联值。
语法
SNMPAPI_STATUS SNMPAPI_CALL SnmpGetVb(
[in] HSNMP_VBL vbl,
[in] smiUINT32 index,
[out] smiLPOID name,
[out] smiLPVALUE value
);
参数
[in] vbl
要检索的变量绑定列表的句柄。
[in] index
指定标识要检索的变量绑定项的无符号长整数变量。 此变量包含变量绑定项在变量绑定列表中的位置。
此参数的有效值在 1 到 n 的范围内,其中 1 表示变量绑定列表中的第一个变量绑定项,n 是列表中的条目总数。 有关其他信息,请参阅以下“备注”部分。
[out] name
指向 smiOID 结构的指针,用于接收变量绑定条目的变量名称。
[out] value
指向 smiVALUE 结构的指针,用于接收与 name 参数标识的变量关联的值。
如果函数成功,值参数指向的结构的语法成员可以是以下语法数据类型之一。 有关其他信息,请参阅 RFC 1902“简单网络管理协议版本 2 的管理信息的结构 (SNMPv2) ”。
返回值
如果函数成功,则返回值SNMPAPI_SUCCESS。
如果函数失败,则返回值SNMPAPI_FAILURE。 若要获取扩展错误信息,请调用 SnmpGetLastError。 SnmpGetLastError 函数可能会返回以下错误之一。
返回代码 | 说明 |
---|---|
|
SnmpStartup 函数未成功完成。 |
|
内存分配期间出错。 |
|
索引参数无效。 |
|
vbl 参数无效。 |
|
发生未知或未定义错误。 |
注解
最后三种语法类型描述了 SNMP 版本 2C (SNMPv2C) 框架下的异常情况。
SnmpGetVb 函数返回 name 参数指向的结构中变量绑定条目的变量名称。 它在 值 参数指向的结构中返回变量的关联值。
在输入时,SnmpGetVb 函数将分别忽略名称参数和值参数所指向的 smiOID 和 smiVALUE 结构的成员。 如果函数成功完成,Microsoft WinSNMP 实现将覆盖成员。
要用于 索引 参数的 WinSNMP 应用程序的有效值如下所示:
- 调用 SnmpCountVbl 函数的返回值
- SNMP_PDU_RESPONSE协议数据单元的错误索引字段 (PDU) 调用 SnmpRecvMsg 函数返回
要求
最低受支持的客户端 | Windows 2000 Professional [仅限桌面应用] |
最低受支持的服务器 | Windows 2000 Server [仅限桌面应用] |
目标平台 | Windows |
标头 | winsnmp.h |
Library | Wsnmp32.lib |
DLL | Wsnmp32.dll |