Fungsi SnmpEntityToStr (winsnmp.h)

Artikel
08/27/2023

[SNMP tersedia untuk digunakan dalam sistem operasi yang ditentukan di bagian Persyaratan. Ini dapat diubah atau tidak tersedia dalam versi berikutnya. Sebagai gantinya, gunakan Manajemen Jarak Jauh Windows, yang merupakan implementasi Microsoft dari WS-Man.]

Fungsi WinSNMP SnmpEntityToStr mengembalikan string yang mengidentifikasi entitas manajemen SNMP.

Sintaks

SNMPAPI_STATUS SNMPAPI_CALL SnmpEntityToStr(
  [in]  HSNMP_ENTITY entity,
  [in]  smiUINT32    size,
  [out] LPSTR        string
);

Parameter

[in] entity

Tangani ke entitas manajemen SNMP yang diminati.

[in] size

Menentukan ukuran, dalam byte, dari buffer yang diacu oleh parameter string . Aplikasi WinSNMP harus mengalokasikan buffer yang cukup besar untuk berisi string output.

[out] string

Arahkan ke buffer untuk menerima string yang dihentikan null yang mengidentifikasi entitas manajemen SNMP yang diminati.

Mengembalikan nilai

Jika fungsi berhasil, nilai yang dikembalikan adalah jumlah byte, termasuk byte null yang mengakhiri, yang dikembalikan SnmpEntityToStr dalam buffer string . Nilai ini bisa kurang dari atau sama dengan nilai parameter ukuran , tetapi tidak boleh lebih besar.

Jika fungsi gagal, nilai yang dikembalikan SNMPAPI_FAILURE. Untuk mendapatkan informasi kesalahan yang diperluas, panggil SnmpGetLastError. Fungsi SnmpGetLastError dapat mengembalikan salah satu kesalahan berikut.

Menampilkan kode	Deskripsi
SNMPAPI_NOT_INITIALIZED	Fungsi SnmpStartup tidak berhasil diselesaikan.
SNMPAPI_ALLOC_ERROR	Terjadi kesalahan selama alokasi memori.
SNMPAPI_ENTITY_INVALID	Parameter entitas tidak valid.
SNMPAPI_OUTPUT_TRUNCATED	Panjang buffer output tidak cukup.
SNMPAPI_OTHER_ERROR	Terjadi kesalahan yang tidak diketahui atau tidak terdefinis.

Keterangan

Pengaturan saat ini dari entitas dan mode terjemahan konteks menentukan jenis string output yang dikembalikan SnmpEntityToStr . Untuk informasi tambahan, lihat Dukungan untuk String Alamat IPX di WinSNMP dan Mengatur Mode Terjemahan Entitas dan Konteks.

Ketika mode terjemahan entitas dan konteks SNMPAPI_TRANSLATED, dan entri ada dalam database implementasi, implementasi mengembalikan nama entitas manajemen yang mudah digunakan terkait. Jika entri tidak ada untuk entitas manajemen, SnmpEntityToStr mengembalikan alamat transportasi SNMP harfiah dari entitas manajemen.

Ketika mode terjemahan entitas dan konteks SNMPAPI_UNTRANSLATED_V1 atau SNMPAPI_UNTRANSLATED_V2, implementasi Microsoft WinSNMP juga mengembalikan alamat transportasi SNMP harfiah dari entitas manajemen.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	winsnmp.h
Pustaka	Wsnmp32.lib
DLL	Wsnmp32.dll

Lihat juga

SnmpStrToEntity

Fungsi WinSNMP

Gambaran Umum API WinSNMP

Bagikan melalui