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 管理實體。
傳回值
如果函式成功,則傳回值是位元組數目,包括終止的 Null 位元組, SnmpEntityToStr 會在 字元串 緩衝區中傳回。 這個值可以小於或等於 size 參數的值,但不能大於。
如果函式失敗,傳回值會SNMPAPI_FAILURE。 若要取得擴充的錯誤資訊,請呼叫 SnmpGetLastError。 SnmpGetLastError 函式可以傳回下列其中一個錯誤。
傳回碼 | Description |
---|---|
|
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 |
程式庫 | Wsnmp32.lib |
Dll | Wsnmp32.dll |