snmpStrToEntity 函式 (winsnmp.h)

發行項
03/04/2024

[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

識別感興趣的SNMP管理實體之 Null 終止字串的指標。實體和內容轉譯模式的目前設定會決定 SnmpStrToEntity 解譯輸入字串的方式，如下所示。

實體/內容轉譯模式	意義
SNMPAPI_TRANSLATED	實作會將字串參數解譯為用戶易記名稱。實作會使用實作的資料庫，將名稱轉譯為其SNMPv1或SNMPv2C元件。
SNMPAPI_UNTRANSLATED_V1	實作會將字串參數解譯為常值 SNMP 傳輸位址。
SNMPAPI_UNTRANSLATED_V2	實作會將字串參數解譯為常值 SNMP 傳輸位址。

傳回值

如果函式成功，則傳回值是感興趣的SNMP管理實體句柄。

如果函式失敗，傳回值會SNMPAPI_FAILURE。若要取得擴充的錯誤資訊，請呼叫 SnmpGetLastError。 SnmpGetLastError 函式可以傳回下列其中一個錯誤。

傳回碼	Description
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 專業版 [僅限傳統型應用程式]
最低支援的伺服器	Windows 2000 Server [僅限傳統型應用程式]
目標平台	Windows
標頭	winsnmp.h
程式庫	Wsnmp32.lib
Dll	Wsnmp32.dll