SnmpContextToStr-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 SnmpContextToStr-Funktion gibt eine Zeichenfolge zurück, die einen SNMP-Kontext identifiziert, bei dem es sich um eine Gruppe verwalteter Objektressourcen handelt. Die Funktion gibt die Zeichenfolge in einer smiOCTETS-Struktur zurück.

Syntax

SNMPAPI_STATUS SNMPAPI_CALL SnmpContextToStr(
  [in]  HSNMP_CONTEXT context,
  [out] smiLPOCTETS   string
);

Parameter

[in] context

Behandeln Sie den SNMP-Kontext von Interesse.

[out] string

Zeiger auf eine smiOCTETS-Struktur , um die Zeichenfolge zu empfangen, die den relevanten Kontext identifiziert. Die Zeichenfolge kann ein Byte mit NULL-Beendigung aufweisen.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert SNMPAPI_SUCCESS.

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_CONTEXT_INVALID	Der Kontextparameter ist ungültig.
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 Ausgabezeichenfolge SnmpContextToStr . Weitere Informationen finden Sie unter Festlegen des Entitäts- und Kontextübersetzungsmodus.

Die WinSNMP-Anwendung muss die Adresse einer gültigen smiOCTETS-Struktur für den Zeichenfolgenparameter angeben. Wenn die SnmpContextToStr-Funktion erfolgreich abgeschlossen wurde, initialisiert die Microsoft WinSNMP-Implementierung die Elemente len und ptr der Struktur. Die WinSNMP-Anwendung muss die SnmpFreeDescriptor-Funktion aufrufen, damit die Implementierung die Ressourcen für diese Member freigeben kann.

Wenn der Entitäts- und Kontextübersetzungsmodus SNMPAPI_TRANSLATED ist und der Eintrag in der Datenbank der Implementierung vorhanden ist, gibt die Implementierung den zugehörigen benutzerfreundlichen Namen des Kontexts zurück. Wenn kein Eintrag für den Kontextnamen vorhanden ist, gibt SnmpContextToStr die SNMP-Communityzeichenfolge zurück.

Wenn der Entitäts- und Kontextübersetzungsmodus SNMPAPI_UNTRANSLATED_V1 oder SNMPAPI_UNTRANSLATED_V2 ist, gibt die Implementierung auch die SNMP-Communityzeichenfolge zurück.

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

SnmpFreeDescriptor

WinSNMP-Funktionen

Übersicht über die WinSNMP-API

smiOCTETS