SnmpStrToContext-Funktion (winsnmp.h)

Artikel
08/27/2023

[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 SnmpStrToContext-Funktion gibt ein Handle für SNMP-Kontextinformationen zurück, das für die Microsoft WinSNMP-Implementierung spezifisch ist. Das Handle ist ein gültiger Wert, den eine WinSNMP-Anwendung als Kontextparameter in einem Aufruf der Funktionen SnmpSendMsg und SnmpRegister verwenden kann.

Syntax

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

Parameter

[in] session

Handle mit der WinSNMP-Sitzung.

[in] string

Zeiger auf eine smiOCTETS-Struktur , die eine zu interpretierende Zeichenfolge enthält. Die Zeichenfolge kann eine Auflistung verwalteter Objekte oder eine Communityzeichenfolge identifizieren.

Die aktuelle Einstellung des Entitäts- und Kontextübersetzungsmodus bestimmt die Art und Weise, wie SnmpStrToContext die Eingabezeichenfolgenstruktur interpretiert, wie in der folgenden Tabelle gezeigt.

Entitäts-/Kontextübersetzungsmodus	Bedeutung
SNMPAPI_TRANSLATED	Die Implementierung interpretiert den Zeichenfolgenparameter als benutzerfreundlichen Namen für eine Auflistung verwalteter Objekte. Die Implementierung übersetzt den Namen mithilfe der Datenbank der Implementierung in ihre SNMPv1- oder SNMPv2C-Komponenten.
SNMPAPI_UNTRANSLATED_V1	Die Implementierung interpretiert den Zeichenfolgenparameter als literale SNMP-Communityzeichenfolge.
SNMPAPI_UNTRANSLATED_V2	Die Implementierung interpretiert den Zeichenfolgenparameter als literale SNMP-Communityzeichenfolge.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ein Handle für den relevanten Kontext.

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_SESSION_INVALID	Der Sitzungsparameter ist ungültig.
SNMPAPI_CONTEXT_INVALID	Das Zeichenfolgenparameterformat ist ungültig. Beispielsweise ist das len-Element oder das ptr-Element der smiOCTETS-Struktur , auf die vom Zeichenfolgenparameter verwiesen wird , NULL.
SNMPAPI_CONTEXT_UNKNOWN	Der Wert, auf den im Zeichenfolgenparameter verwiesen wird, ist nicht vorhanden.
SNMPAPI_OTHER_ERROR	Ein unbekannter oder nicht definierter Fehler ist aufgetreten.

Hinweise

Die aktuelle Einstellung des Entitäts- und Kontextübersetzungsmodus bestimmt die Art und Weise, in der SnmpStrToContext die Eingabezeichenfolgenstruktur interpretiert. Weitere Informationen finden Sie unter Festlegen des Entitäts- und Kontextübersetzungsmodus.

Die WinSNMP-Anwendung muss die SnmpFreeContext-Funktion aufrufen, um das von der SnmpStrToContext-Funktion zugewiesene Kontexthandle freizugeben. Weitere Informationen zum Freigeben von Ressourcen finden Sie unter WinSNMP Datenverwaltung Concepts.

Die WinSNMP-Anwendung sollte den Arbeitsspeicher freigeben, der dem ptr-Member der smiOCTETS-Struktur zugeordnet ist, auf die der Zeichenfolgenparameter verweist. Dies liegt daran, dass die Anwendung die Ressourcen definiert und zuordnet. Wenn die Anwendung beispielsweise Ressourcen mit einem Aufruf der GlobalAlloc-Funktion zugeordnet hat, sollte sie die GlobalFree-Funktion verwenden, um die Ressourcen zuzuordnen. Weitere Informationen finden Sie unter Freigeben von WinSNMP-Deskriptoren.

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