Fungsi SnmpOidToStr (winsnmp.h)
[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 SnmpOidToStr mengonversi representasi biner internal pengidentifikasi objek SNMP ke format string numerik putus-putus, misalnya, menjadi "1.2.3.4.5.6".
Sintaks
SNMPAPI_STATUS SNMPAPI_CALL SnmpOidToStr(
[in] smiLPCOID srcOID,
[in] smiUINT32 size,
[out] LPSTR string
);
Parameter
[in] srcOID
Arahkan ke struktur smiOID dengan pengidentifikasi objek untuk dikonversi.
[in] size
Menentukan ukuran, dalam byte, dari buffer yang ditunjukkan oleh parameter string . Untuk informasi selengkapnya, lihat bagian Keterangan berikut ini.
[out] string
Arahkan ke buffer untuk menerima pengidentifikasi objek string yang dikonversi yang menentukan entitas manajemen SNMP.
Mengembalikan nilai
Jika fungsi berhasil, nilai yang dikembalikan adalah panjangnya, dalam byte, dari string yang ditulis aplikasi WinSNMP ke parameter string . Nilai yang dikembalikan mencakup byte yang dihentikan null. Nilai ini mungkin kurang dari atau sama dengan nilai parameter ukuran , tetapi mungkin tidak lebih besar.
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.
| Menampilkan kode | Deskripsi |
|---|---|
|
Fungsi SnmpStartup tidak berhasil diselesaikan. |
|
Terjadi kesalahan selama alokasi memori. |
|
Parameter ukuran tidak valid. Parameter ini tidak boleh sama dengan nol; itu harus menunjukkan ukuran buffer yang ditunjukkan oleh parameter string . |
|
Parameter srcOID tidak valid. Untuk informasi tambahan, lihat bagian Keterangan berikut ini. |
|
Panjang buffer output tidak cukup. |
|
Terjadi kesalahan yang tidak diketahui atau tidak terdefinis. |
Keterangan
Disarankan agar aplikasi WinSNMP menentukan, dengan parameter ukuran , buffer string dengan panjang MAXOBJIDSTRSIZE (1408 byte). Ini memastikan bahwa buffer output cukup besar untuk menahan string yang dikonversi. Karena string yang dikonversi biasanya kurang dari MAXOBJIDSTRSIZE, aplikasi WinSNMP dapat menyalin string yang dikonversi ke buffer yang lebih kecil. Aplikasi kemudian dapat menggunakan kembali atau membebaskan memori yang dialokasikan untuk buffer awal. Untuk informasi tambahan, lihat Konsep Manajemen Data 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 |