SnmpOidToStr-Funktion (winsnmp.h)

Artikel
08/27/2023

[SNMP ist für die Verwendung in den im Abschnitt Anforderungen angegebenen Betriebssystemen verfügbar. Es kann in nachfolgenden Versionen geändert oder entfernt werden. Verwenden Sie stattdessen die Windows-Remoteverwaltung, die Microsoft-Implementierung von WS-Man.]

Die WinSNMP-Funktion SnmpOidToStr konvertiert die interne binäre Darstellung eines SNMP-Objektbezeichners in das gepunktete numerische Zeichenfolgenformat, z. B. in "1.2.3.4.5.6".

Syntax

SNMPAPI_STATUS SNMPAPI_CALL SnmpOidToStr(
  [in]  smiLPCOID srcOID,
  [in]  smiUINT32 size,
  [out] LPSTR     string
);

Parameter

[in] srcOID

Zeiger auf eine smiOID-Struktur mit einem zu konvertierenden Objektbezeichner.

[in] size

Gibt die Größe des Puffers in Bytes an, der durch den Zeichenfolgenparameter angegeben wird. Weitere Informationen finden Sie im folgenden Abschnitt "Hinweise".

[out] string

Zeiger auf einen Puffer, um den konvertierten Zeichenfolgenobjektbezeichner zu empfangen, der die SNMP-Verwaltungsentität angibt.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert die Länge der Zeichenfolge in Bytes, die die WinSNMP-Anwendung in den Zeichenfolgenparameter schreibt. Der Rückgabewert enthält ein Byte mit NULL-Beendigung. Dieser Wert kann kleiner oder gleich dem Wert des Größenparameters sein, aber er ist möglicherweise nicht größer.

Wenn die Funktion fehlschlägt, wird der Rückgabewert SNMPAPI_FAILURE. Rufen Sie SnmpGetLastError auf, um erweiterte Fehlerinformationen zu erhalten, und geben Sie einen NULL-Wert im Sitzungsparameter an. Die SnmpGetLastError-Funktion kann einen der folgenden Fehler zurückgeben.

Rückgabecode	Beschreibung
SNMPAPI_NOT_INITIALIZED	Die SnmpStartup-Funktion wurde nicht erfolgreich abgeschlossen.
SNMPAPI_ALLOC_ERROR	Während der Speicherbelegung ist ein Fehler aufgetreten.
SNMPAPI_SIZE_INVALID	Der Size-Parameter ist ungültig. Dieser Parameter darf nicht gleich 0 sein. Sie muss die Größe des Puffers angeben, auf den der Zeichenfolgenparameter verweist.
SNMPAPI_OID_INVALID	Der srcOID-Parameter ist ungültig. Weitere Informationen finden Sie im folgenden Abschnitt "Hinweise".
SNMPAPI_OUTPUT_TRUNCATED	Die Länge des Ausgabepuffers reicht nicht aus.
SNMPAPI_OTHER_ERROR	Es ist ein unbekannter oder nicht definierter Fehler aufgetreten.

Hinweise

Es wird empfohlen, dass eine WinSNMP-Anwendung mit dem Parameter size einen Zeichenfolgenpuffer der Länge MAXOBJIDSTRSIZE (1408 Bytes) angibt. Dadurch wird sichergestellt, dass der Ausgabepuffer groß genug ist, um die konvertierte Zeichenfolge zu enthalten. Da die konvertierte Zeichenfolge in der Regel kleiner als MAXOBJIDSTRSIZE ist, kann die WinSNMP-Anwendung die konvertierte Zeichenfolge in einen kleineren Puffer kopieren. Die Anwendung kann dann den Arbeitsspeicher, den sie für den anfänglichen Puffer zugewiesen hat, wiederverwenden oder freigeben. Weitere Informationen finden Sie unter WinSNMP Datenverwaltung Concepts.

Anforderungen


Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	winsnmp.h
Bibliothek	Wsnmp32.lib
DLL	Wsnmp32.dll

Weitere Informationen

SnmpStrToOid

WinSNMP-Funktionen

Übersicht über winSNMP-API

smiOID

Share via