Fungsi SnmpEncodeMsg (winsnmp.h)

Artikel
03/04/2024

[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.]

Implementasi Microsoft WinSNMP menggunakan parameter yang diteruskan dalam fungsi WinSNMP SnmpEncodeMsg untuk mengodekan pesan SNMP. Implementasi mengembalikan pesan SNMP yang dikodekan ke aplikasi WinSNMP dalam buffer yang ditentukan oleh parameter msgBufDesc .

Sintaks

SNMPAPI_STATUS SNMPAPI_CALL SnmpEncodeMsg(
  [in]  HSNMP_SESSION session,
  [in]  HSNMP_ENTITY  srcEntity,
  [in]  HSNMP_ENTITY  dstEntity,
  [in]  HSNMP_CONTEXT context,
  [in]  HSNMP_PDU     pdu,
  [out] smiLPOCTETS   msgBufDesc
);

Parameter

[in] session

Tangani ke sesi WinSNMP.

[in] srcEntity

Tangani ke entitas manajemen yang memulai permintaan untuk mengodekan pesan SNMP.

[in] dstEntity

Tangani ke entitas manajemen target.

[in] context

Tangani konteks (sekumpulan sumber daya objek terkelola) yang dikontrol entitas manajemen target.

[in] pdu

Tangani ke PDU yang berisi permintaan operasi SNMP.

[out] msgBufDesc

Arahkan ke struktur smiOCTETS yang menerima pesan SNMP yang dikodekan.

Mengembalikan nilai

Jika fungsi berhasil, nilai yang dikembalikan adalah panjangnya, dalam byte, dari pesan SNMP yang dikodekan. Angka ini juga merupakan nilai anggota len dari struktur smiOCTETS yang diarahkan oleh parameter msgBufDesc .

Jika fungsi gagal, nilai yang dikembalikan SNMPAPI_FAILURE. Untuk informasi tambahan, lihat bagian Keterangan berikut ini. 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_SESSION_INVALID	Parameter sesi tidak valid.
SNMPAPI_ENTITY_INVALID	Salah satu atau kedua parameter entitas tidak valid.
SNMPAPI_CONTEXT_INVALID	Parameter konteks tidak valid.
SNMPAPI_PDU_INVALID	Parameter pdu tidak valid.
SNMPAPI_OTHER_ERROR	Terjadi kesalahan yang tidak diketahui atau tidak terdefinis.

Keterangan

Lima parameter pertama yang diteruskan ke fungsi SnmpEncodeMsg adalah parameter yang sama yang diteruskan ke fungsi SnmpSendMsg .

Aplikasi WinSNMP harus memanggil fungsi SnmpFreeDescriptor ke sumber daya gratis yang dialokasikan untuk anggota ptr struktur smiOCTETS . Ini adalah struktur yang ditunjukkan oleh parameter msgBufDesc . Untuk informasi tambahan, lihat Konsep Manajemen Data WinSNMP.

Pada input, fungsi SnmpEncodeMsg mengabaikan anggota struktur yang diacu oleh parameter msgBufDesc . Implementasi menimpa anggota struktur jika fungsi berhasil diselesaikan.

Implementasi memverifikasi format lima parameter input pertama. Jika salah satu parameter tidak valid, SnmpEncodeMsg mengembalikan SNMPAPI_FAILURE, dan SnmpGetLastError mengembalikan kode kesalahan yang diperluas.

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