SnmpStrToEntity 函数 (winsnmp.h)

项目
08/27/2023

[SNMP 可用于“要求”部分中指定的操作系统。它可能在后续版本中变更或不可用。请改用 Windows 远程管理，这是 WS-Man 的 Microsoft 实现。]

WinSNMP SnmpStrToEntity 函数返回有关特定于 Microsoft WinSNMP 实现的 SNMP 管理实体的信息的句柄。

语法

HSNMP_ENTITY SNMPAPI_CALL SnmpStrToEntity(
  [in] HSNMP_SESSION session,
  [in] LPCSTR        string
);

参数

[in] session

WinSNMP 会话的句柄。

[in] string

指向以 null 结尾的字符串的指针，该字符串标识感兴趣的 SNMP 管理实体。实体和上下文转换模式的当前设置确定 SnmpStrToEntity 解释输入字符串的方式，如下所示。

实体/上下文转换模式	含义
SNMPAPI_TRANSLATED	实现将字符串参数解释为用户友好名称。实现使用实现的数据库将名称转换为其 SNMPv1 或 SNMPv2C 组件。
SNMPAPI_UNTRANSLATED_V1	实现将字符串参数解释为文本 SNMP 传输地址。
SNMPAPI_UNTRANSLATED_V2	实现将字符串参数解释为文本 SNMP 传输地址。

返回值

如果函数成功，则返回值是感兴趣的 SNMP 管理实体的句柄。

如果函数失败，则返回值SNMPAPI_FAILURE。若要获取扩展错误信息，请调用 SnmpGetLastError。 SnmpGetLastError 函数可能会返回以下错误之一。

返回代码	说明
SNMPAPI_NOT_INITIALIZED	SnmpStartup 函数未成功完成。
SNMPAPI_ALLOC_ERROR	内存分配期间出错。
SNMPAPI_SESSION_INVALID	会话参数无效。
SNMPAPI_ENTITY_UNKNOWN	实体字符串无效。
SNMPAPI_OTHER_ERROR	发生未知或未定义错误。

注解

实体和上下文转换模式的当前设置确定 SnmpStrToEntity 解释标识相关管理实体的输入字符串的方式。有关其他信息，请参阅支持 WinSNMP 中的 IPX 地址字符串和设置实体和上下文转换模式。

WinSNMP 应用程序应调用 SnmpFreeEntity 函数，以释放 SnmpStrToEntity 函数分配的实体句柄。有关其他信息，请参阅 WinSNMP 数据管理概念。

SnmpStrToEntity 函数返回一个有效的实体句柄，WinSNMP 应用程序可以在多个 WinSNMP 函数中用作 srcEntity 或 dstEntity 参数。这些函数包括 SnmpSendMsg、 SnmpRecvMsg、 SnmpRegister、 SnmpEncodeMsg 和 SnmpDecodeMsg 函数。

实现在 SnmpStartup 函数的 nTranslateMode 参数中返回当前实体和上下文转换模式。 WinSNMP 应用程序可以通过调用 SnmpSetTranslateMode 函数来更改实体和上下文转换模式的设置。

要求

要求	值
最低受支持的客户端	Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器	Windows 2000 Server [仅限桌面应用]
目标平台	Windows
标头	winsnmp.h
Library	Wsnmp32.lib
DLL	Wsnmp32.dll