Fungsi SnmpStrToContext (winsnmp.h)

2023-08-27

[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 SnmpStrToContext mengembalikan handel ke informasi konteks SNMP yang khusus untuk implementasi Microsoft WinSNMP. Handel adalah nilai valid yang dapat digunakan aplikasi WinSNMP sebagai parameter konteks dalam panggilan ke fungsi SnmpSendMsg dan SnmpRegister .

Sintaks

HSNMP_CONTEXT SNMPAPI_CALL SnmpStrToContext(
  [in] HSNMP_SESSION session,
  [in] smiLPCOCTETS  string
);

Parameter

[in] session

Tangani ke sesi WinSNMP.

[in] string

Penunjuk ke struktur smiOCTETS yang berisi string untuk ditafsirkan. String dapat mengidentifikasi kumpulan objek terkelola, atau dapat berupa string komunitas.

Pengaturan saat ini dari entitas dan mode terjemahan konteks menentukan cara SnmpStrToContext menginterpretasikan struktur string input seperti yang ditunjukkan dalam tabel berikut.

Mode Terjemahan Entitas/Konteks	Makna
SNMPAPI_TRANSLATED	Implementasi menginterpretasikan parameter string sebagai nama yang mudah digunakan untuk kumpulan objek terkelola. Implementasi menerjemahkan nama ke dalam komponen SNMPv1 atau SNMPv2C menggunakan database implementasi.
SNMPAPI_UNTRANSLATED_V1	Implementasi menginterpretasikan parameter string sebagai string komunitas SNMP harfiah.
SNMPAPI_UNTRANSLATED_V2	Implementasi menginterpretasikan parameter string sebagai string komunitas SNMP harfiah.

Mengembalikan nilai

Jika fungsi berhasil, nilai yang dikembalikan adalah handel untuk konteks yang diminati.

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_SESSION_INVALID	Parameter sesi tidak valid.
SNMPAPI_CONTEXT_INVALID	Format parameter string tidak valid. Misalnya, anggota len atau anggota ptr dari struktur smiOCTETS yang diarahkan oleh parameter string adalah NULL.
SNMPAPI_CONTEXT_UNKNOWN	Nilai yang dirujuk dalam parameter string tidak ada.
SNMPAPI_OTHER_ERROR	Terjadi kesalahan yang tidak diketahui atau tidak terdefinis.

Keterangan

Pengaturan entitas dan mode terjemahan konteks saat ini menentukan cara SnmpStrToContext menginterpretasikan struktur string input. Untuk informasi tambahan, lihat Mengatur Mode Terjemahan Entitas dan Konteks.

Aplikasi WinSNMP harus memanggil fungsi SnmpFreeContext untuk merilis handel konteks yang dialokasikan oleh fungsi SnmpStrToContext . Untuk informasi tambahan tentang merilis sumber daya, lihat Konsep Manajemen Data WinSNMP.

Aplikasi WinSNMP harus membebaskan memori yang terkait dengan anggota ptr struktur smiOCTETS yang diacu oleh parameter string . Ini karena aplikasi menentukan dan mengalokasikan sumber daya. Misalnya, jika aplikasi mengalokasikan sumber daya dengan panggilan ke fungsi GlobalAlloc , aplikasi harus menggunakan fungsi GlobalFree untuk membatalkan alokasi sumber daya. Untuk informasi tambahan, lihat Membebaskan Deskriptor WinSNMP.

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	winsnmp.h
Pustaka	Wsnmp32.lib
DLL	Wsnmp32.dll