Fungsi SnmpMgrCtl (mgmtapi.h)

Artikel
08/24/2023

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

Fungsi SnmpMgrCtl menetapkan parameter operasi yang terkait dengan sesi SNMP. Fungsi ini adalah elemen dari SNMP Management API.

Sintaks

BOOL SNMP_FUNC_TYPE SnmpMgrCtl(
  [in]  LPSNMP_MGR_SESSION session,
  [in]  DWORD              dwCtlCode,
  [in]  LPVOID             lpvInBuffer,
  [in]  DWORD              cbInBuffer,
  [out] LPVOID             lpvOUTBuffer,
  [out] DWORD              cbOUTBuffer,
  [out] LPDWORD            lpcbBytesReturned
);

Parameter

[in] session

Penunjuk ke struktur internal yang menentukan sesi tempat kode kontrol diterapkan.

[in] dwCtlCode

Menentukan nilai (kode kontrol) yang mengidentifikasi operasi yang akan dilakukan.

Saat ini, MGMCTL_SETAGENTPORT adalah satu-satunya kode kontrol yang didukung. Mengatur kode ini memungkinkan aplikasi manajemen SNMP untuk mengirim permintaan ke agen jarak jauh yang "mendengarkan" untuk permintaan manajer SNMP pada port arbitrer. Untuk informasi selengkapnya, lihat deskripsi parameter lpvInBuffer dan cbInBuffer .

[in] lpvInBuffer

Penunjuk ke buffer yang berisi parameter input yang diperlukan untuk operasi.

Ketika Anda menentukan kode kontrol MGMCTL_SETAGENTPORT, parameter ini harus menunjuk ke bilangan bulat yang tidak ditandatangani yang menentukan nomor port tempat agen jarak jauh akan "mendengarkan" untuk permintaan manajer SNMP. Nomor port harus dalam urutan host-byte.

[in] cbInBuffer

Menentukan ukuran, dalam byte, dari buffer yang diacu oleh parameter lpvInBuffer .

Saat Anda menentukan kode kontrol MGMCTL_SETAGENTPORT, parameter ini sama dengan sizeof(UINT).

[out] lpvOUTBuffer

Arahkan ke buffer yang menerima data output operasi.

[out] cbOUTBuffer

Menentukan ukuran, dalam byte, dari buffer yang diacu oleh parameter lpvOutBuffer .

[out] lpcbBytesReturned

Penunjuk ke variabel yang menerima ukuran aktual, dalam byte, dari data yang disimpan dalam buffer yang ditujukkan oleh parameter lpvOutBuffer .

Menampilkan nilai

Jika fungsi berhasil, nilai yang dikembalikan bukan nol.

Jika fungsi gagal, nilai yang dikembalikan adalah nol. Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError. GetLastError juga dapat mengembalikan salah satu kode kesalahan berikut.

Menampilkan kode	Deskripsi
SNMP_MGMTAPI_INVALID_CTL	Parameter dwCtlCode tidak menentukan kode kontrol yang valid.
SNMP_MGMTAPI_INVALID_SESSION	Parameter sesi tidak menentukan sesi SNMP yang valid.
SNMP_MGMTAPI_INVALID_BUFFER	Satu atau beberapa parameter lpvInBuffer, lpvOutBuffer, atau lpcbBytesRequired tidak valid, atau parameter cbInBuffer atau cbOutBuffer terlalu kecil.

Persyaratan


Klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	mgmtapi.h
Pustaka	Mgmtapi.lib
DLL	Mgmtapi.dll

Lihat juga

Fungsi SNMP

Gambaran Umum Simple Network Management Protocol (SNMP)

SnmpMgrBuka

Bagikan melalui