SnmpStrToEntity-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 SnmpStrToEntity gibt ein Handle zu Informationen zu einer SNMP-Verwaltungsentität zurück, die für die Microsoft WinSNMP-Implementierung spezifisch ist.

Syntax

HSNMP_ENTITY SNMPAPI_CALL SnmpStrToEntity(
  [in] HSNMP_SESSION session,
  [in] LPCSTR        string
);

Parameter

[in] session

Handle für die WinSNMP-Sitzung.

[in] string

Zeiger auf eine NULL-Zeichenfolge, die die interessierende SNMP-Verwaltungsentität identifiziert. Die aktuelle Einstellung des Entitäts- und Kontextübersetzungsmodus bestimmt die Art und Weise, in der SnmpStrToEntity die Eingabezeichenfolge wie folgt interpretiert.

Entitäts-/Kontextübersetzungsmodus	Bedeutung
SNMPAPI_TRANSLATED	Die Implementierung interpretiert den Zeichenfolgenparameter als benutzerfreundlichen Namen. 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-Transportadresse.
SNMPAPI_UNTRANSLATED_V2	Die Implementierung interpretiert den Zeichenfolgenparameter als literale SNMP-Transportadresse.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ein Handle für die snmp-Verwaltungsentität von Interesse.

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 Speicherbelegung ist ein Fehler aufgetreten.
SNMPAPI_SESSION_INVALID	Der Sitzungsparameter ist ungültig.
SNMPAPI_ENTITY_UNKNOWN	Die Entitätszeichenfolge ist ungültig.
SNMPAPI_OTHER_ERROR	Es ist ein unbekannter oder nicht definierter Fehler aufgetreten.

Hinweise

Die aktuelle Einstellung des Entitäts- und Kontextübersetzungsmodus bestimmt die Art und Weise, in der SnmpStrToEntity die Eingabezeichenfolge interpretiert, die die von Interessede Verwaltungsentität identifiziert. Weitere Informationen finden Sie unter Unterstützung für IPX-Adresszeichenfolgen in WinSNMP und Festlegen des Entitäts- und Kontextübersetzungsmodus.

Die WinSNMP-Anwendung sollte die SnmpFreeEntity-Funktion aufrufen, um das von der SnmpStrToEntity-Funktion zugeordnete Entitätshandle freizugeben. Weitere Informationen finden Sie unter WinSNMP Datenverwaltung Concepts.

Die SnmpStrToEntity-Funktion gibt ein gültiges Entitätshandle zurück, das eine WinSNMP-Anwendung als srcEntity - oder dstEntity-Parameter in mehreren WinSNMP-Funktionen verwenden kann. Zu diesen Funktionen gehören die Funktionen SnmpSendMsg, SnmpRecvMsg, SnmpRegister, SnmpEncodeMsg und SnmpDecodeMsg .

Die Implementierung gibt den aktuellen Entitäts- und Kontextübersetzungsmodus im Parameter nTranslateMode der SnmpStartup-Funktion zurück. Eine WinSNMP-Anwendung kann die Einstellung des Entitäts- und Kontextübersetzungsmodus mit einem Aufruf der SnmpSetTranslateMode-Funktion ändern.

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