Fungsi SnmpStartup (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.]

Fungsi SnmpStartup memberi tahu implementasi Microsoft WinSNMP bahwa aplikasi WinSNMP memerlukan layanan implementasi. Fungsi WinSNMP SnmpStartup memungkinkan implementasi untuk menginisialisasi dan kembali ke aplikasi versi Windows SNMP Application Programming Interface (WinSNMP API), tingkat komunikasi SNMP yang didukung implementasi, dan mode terjemahan dan transmisi ulang default implementasi.

Catatan Aplikasi WinSNMP harus memanggil fungsi SnmpStartup dengan sukses sebelum memanggil fungsi WinSNMP lainnya.

Sintaks

SNMPAPI_STATUS SNMPAPI_CALL SnmpStartup(
  [out] smiLPUINT32 nMajorVersion,
  [out] smiLPUINT32 nMinorVersion,
  [out] smiLPUINT32 nLevel,
  [out] smiLPUINT32 nTranslateMode,
  [out] smiLPUINT32 nRetransmitMode
);

Parameter

[out] nMajorVersion

Arahkan ke variabel bilangan bulat panjang yang tidak ditandatangani untuk menerima nomor versi utama API WinSNMP yang didukung implementasi. Misalnya, untuk menunjukkan bahwa implementasi mendukung WinSNMP versi 2.0, fungsi mengembalikan nilai 2.

[out] nMinorVersion

Arahkan ke variabel bilangan bulat panjang yang tidak ditandatangani untuk menerima nomor versi minor api WinSNMP yang didukung implementasi. Misalnya, untuk menunjukkan bahwa implementasi mendukung WinSNMP versi 2.0, fungsi mengembalikan nilai 0.

[out] nLevel

Arahkan ke variabel bilangan bulat panjang yang tidak ditandatangani untuk menerima tingkat komunikasi SNMP tertinggi yang didukung implementasi. Setelah berhasil dikembalikan, parameter ini berisi nilai 2. Untuk deskripsi dukungan tingkat 2, lihat Tingkat Dukungan SNMP.

[out] nTranslateMode

Penunjuk ke variabel bilangan bulat panjang yang tidak ditandatangani untuk menerima mode terjemahan default yang berlaku untuk implementasi. Mode terjemahan berlaku untuk interpretasi implementasi parameter entitas yang diteruskan aplikasi WinSNMP ke fungsi SnmpStrToEntity . Mode terjemahan juga berlaku untuk parameter string yang diteruskan aplikasi WinSNMP ke fungsi SnmpStrToContext . Parameter ini bisa menjadi salah satu nilai berikut.

Nilai	Makna
SNMPAPI_TRANSLATED	Implementasi menggunakan databasenya untuk menerjemahkan nama yang mudah digunakan untuk entitas SNMP dan objek terkelola. Implementasi menerjemahkannya ke dalam komponen SNMPv1 atau SNMPv2C mereka.
SNMPAPI_UNTRANSLATED_V1	Implementasi ini menginterpretasikan parameter entitas SNMP sebagai alamat transportasi SNMP, dan parameter konteks sebagai string komunitas SNMP. Untuk entitas tujuan SNMPv2, implementasi membuat pesan SNMP keluar yang berisi nilai nol di bidang versi.
SNMPAPI_UNTRANSLATED_V2	Implementasi ini menginterpretasikan parameter entitas SNMP sebagai alamat transportasi SNMP, dan parameter konteks sebagai string komunitas SNMP. Untuk entitas tujuan SNMPv2, implementasi membuat pesan SNMP keluar yang berisi nilai 1 di bidang versi.

Untuk informasi tambahan, lihat Mengatur Mode Terjemahan Entitas dan Konteks.

[out] nRetransmitMode

Penunjuk ke variabel bilangan bulat panjang yang tidak ditandatangani untuk menerima mode transmisi ulang default yang berlaku untuk implementasi. Parameter ini bisa menjadi salah satu nilai berikut.

Nilai	Makna
SNMPAPI_OFF	Implementasinya tidak menjalankan kebijakan transmisi ulang aplikasi WinSNMP.
SNMPAPI_ON	Implementasinya adalah menjalankan kebijakan transmisi ulang aplikasi WinSNMP.

Untuk informasi tambahan, lihat Tentang Transmisi Ulang.

Mengembalikan nilai

Jika fungsi berhasil, nilai yang dikembalikan SNMPAPI_SUCCESS, dan parameter berisi nilai yang sesuai, seperti yang ditunjukkan dalam deskripsi parameter sebelumnya.

Jika fungsi gagal, nilai yang dikembalikan SNMPAPI_FAILURE. Untuk mendapatkan informasi kesalahan yang diperluas, panggil SnmpGetLastError yang menentukan nilai NULL dalam parameter sesinya . Fungsi SnmpGetLastError dapat mengembalikan salah satu kesalahan berikut. Untuk informasi tambahan, lihat bagian Keterangan yang mengikuti.

Menampilkan kode	Deskripsi
SNMPAPI_NOT_INITIALIZED	Fungsi SnmpStartup tidak berhasil diselesaikan.
SNMPAPI_ALLOC_ERROR	Terjadi kesalahan selama alokasi memori.
SNMPAPI_OTHER_ERROR	Terjadi kesalahan yang tidak diketahui atau tidak terdefinis.

Keterangan

Aplikasi WinSNMP harus memanggil fungsi SnmpStartup dengan sukses setidaknya sekali, sebelum memanggil fungsi WinSNMP lainnya. Jika aplikasi WinSNMP memanggil fungsi WinSNMP lain, sebelum berhasil memanggil SnmpStartup, implementasi mengembalikan kesalahan SNMPAPI_NOT_INITIALIZED.

Aplikasi WinSNMP dapat memanggil SnmpGetLastError untuk informasi kesalahan, atau mencoba kembali SnmpStartup jika panggilan ke fungsi SnmpStartup gagal. Ketika SnmpStartup mengembalikan SNMPAPI_FAILURE, dan panggilan berikutnya ke SnmpGetLastError mengembalikan SNMP_ALLOC_ERROR, aplikasi WinSNMP dapat memilih untuk menunggu. Ini dapat mencoba kembali panggilan ke SnmpStartup ketika implementasi memiliki sumber daya gratis yang memadai.

Aplikasi WinSNMP dapat memanggil SnmpStartup beberapa kali. Misalnya, mungkin perlu mencoba kembali panggilan fungsi karena alasan yang dibahas sebelumnya. Aplikasi WinSNMP juga harus memanggil SnmpCleanup setidaknya sekali, karena panggilan fungsi WinSNMP terakhir sebelum berakhir. Beberapa panggilan SnmpStartup tidak memerlukan beberapa panggilan SnmpCleanup .

Untuk informasi tambahan, lihat Tingkat Dukungan SNMP dan Tentang Versi SNMP.

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

Gambaran Umum API WinSNMP