snmpStrToCoNtext 函式 (winsnmp.h)

發行項
08/27/2023

[SNMP 可用於需求一節中指定的作業系統。它在後續版本中可能會變更或無法使用。請改用 Windows 遠端系統管理，這是 WS-Man 的 Microsoft 實作。

WinSNMP SnmpStrToCoNtext 函式會傳回 Microsoft WinSNMP 實作特有的 SNMP 內容資訊控制碼。控制碼是 WinSNMP 應用程式可以在對SnmpSendMsg和SnmpRegister函式的呼叫中做為內容參數的有效值。

語法

HSNMP_CONTEXT SNMPAPI_CALL SnmpStrToContext(
  [in] HSNMP_SESSION session,
  [in] smiLPCOCTETS  string
);

參數

[in] session

WinSNMP 會話的控制碼。

[in] string

包含要解譯之字串的 smiOCTETS 結構的指標。字串可以識別 Managed 物件的集合，或者它可以是社群字串。

實體和內容轉譯模式的目前設定會決定 SnmpStrToCoNtext 解譯輸入字串結構的方式，如下表所示。

實體/內容轉譯模式	意義
SNMPAPI_TRANSLATED	實作會將字串參數解譯為 Managed 物件集合的使用者易記名稱。實作會使用實作的資料庫，將名稱轉譯為其 SNMPv1 或 SNMPv2C 元件。
SNMPAPI_UNTRANSLATED_V1	實作會將字串參數解譯為常值 SNMP 社群字串。
SNMPAPI_UNTRANSLATED_V2	實作會將字串參數解譯為常值 SNMP 社群字串。

傳回值

如果函式成功，則傳回值是相關內容的控制碼。

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

傳回碼	描述
SNMPAPI_NOT_INITIALIZED	SnmpStartup函式未順利完成。
SNMPAPI_ALLOC_ERROR	記憶體配置期間發生錯誤。
SNMPAPI_SESSION_INVALID	會話參數無效。
SNMPAPI_CONTEXT_INVALID	字串參數格式無效。例如，字串參數所指向之 smiOCTETS結構的len成員或ptr成員為Null。
SNMPAPI_CONTEXT_UNKNOWN	字串參數中所參考的值不存在。
SNMPAPI_OTHER_ERROR	發生未知或未定義的錯誤。

備註

實體和內容轉譯模式的目前設定會決定 SnmpStrToCoNtext 解譯輸入字串結構的方式。如需詳細資訊，請參閱設定實體和內容轉譯模式。

WinSNMP 應用程式必須呼叫 SnmpFreeCoNtext 函式，以釋放 SnmpStrToCoNtext 函式所配置的內容控制碼。如需發行資源的其他資訊，請參閱WinSNMP 資料管理概念。

WinSNMP 應用程式應該釋放與字串參數所指向之 smiOCTETS結構ptr成員相關聯的記憶體。這是因為應用程式會定義並配置資源。例如，如果應用程式使用對 GlobalAlloc 函式的呼叫配置資源，它應該使用 GlobalFree 函式來解除配置資源。如需詳細資訊，請參閱釋放 WinSNMP 描述元。

規格需求


最低支援的用戶端	Windows 2000 專業版 [僅限傳統型應用程式]
最低支援的伺服器	Windows 2000 Server [僅限傳統型應用程式]
目標平台	Windows
標頭	winsnmp.h
程式庫	Wsnmp32.lib
Dll	Wsnmp32.dll