SnmpEntityToStr-Funktion (winsnmp.h)

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

Die WinSNMP SnmpEntityToStr-Funktion gibt eine Zeichenfolge zurück, die eine SNMP-Verwaltungsentität identifiziert.

Syntax

SNMPAPI_STATUS SNMPAPI_CALL SnmpEntityToStr(
  [in]  HSNMP_ENTITY entity,
  [in]  smiUINT32    size,
  [out] LPSTR        string
);

Parameter

[in] entity

Handle an die SNMP-Verwaltungsentität von Interesse.

[in] size

Gibt die Größe des Puffers in Bytes an, auf den der Zeichenfolgenparameter verweist. Die WinSNMP-Anwendung muss einen Puffer zuordnen, der groß genug ist, um die Ausgabezeichenfolge zu enthalten.

[out] string

Zeiger auf einen Puffer, um die null-beendete Zeichenfolge zu empfangen, die die snmp-Verwaltungsentität von Interesse identifiziert.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert die Anzahl von Bytes, einschließlich eines beendenden NULL-Byte, die SnmpEntityToStr im Zeichenfolgenpuffer zurückgibt. Dieser Wert kann kleiner oder gleich dem Wert des Größenparameters sein, kann aber nicht größer sein.

Wenn die Funktion fehlschlägt, wird der Rückgabewert SNMPAPI_FAILURE. Rufen Sie SnmpGetLastError auf, um erweiterte Fehlerinformationen zu erhalten. 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 Speicherzuordnung ist ein Fehler aufgetreten.
SNMPAPI_ENTITY_INVALID	Der Entitätsparameter ist ungültig.
SNMPAPI_OUTPUT_TRUNCATED	Die Länge des Ausgabepuffers reicht nicht aus.
SNMPAPI_OTHER_ERROR	Ein unbekannter oder nicht definierter Fehler ist aufgetreten.

Hinweise

Die aktuelle Einstellung des Entitäts- und Kontextübersetzungsmodus bestimmt den Typ der Zurückgegebenen Ausgabezeichenfolge SnmpEntityToStr . Weitere Informationen finden Sie unter Unterstützung für IPX-Adresszeichenfolgen in WinSNMP und Festlegen des Entitäts- und Kontextübersetzungsmodus.

Wenn der Entitäts- und Kontextübersetzungsmodus SNMPAPI_TRANSLATED ist und ein Eintrag in der Datenbank der Implementierung vorhanden ist, gibt die Implementierung den zugehörigen benutzerfreundlichen Namen der Verwaltungsentität zurück. Wenn kein Eintrag für die Verwaltungsentität vorhanden ist, gibt SnmpEntityToStr die literale SNMP-Transportadresse der Verwaltungsentität zurück.

Wenn der Entitäts- und Kontextübersetzungsmodus SNMPAPI_UNTRANSLATED_V1 oder SNMPAPI_UNTRANSLATED_V2 ist, gibt die Microsoft WinSNMP-Implementierung auch die literale SNMP-Transportadresse der Verwaltungsentität zurück.

Anforderungen

Anforderung	Wert
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

SnmpStrToEntity

WinSNMP-Funktionen

Übersicht über die WinSNMP-API