SnmpListen-Funktion (winsnmp.h)

Artikel
03/13/2024

[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-SnmpListen-Funktion registriert eine WinSNMP-Anwendung als SNMP-Agent. Eine Agentanwendung ruft diese Funktion auf, um die Microsoft WinSNMP-Implementierung darüber zu informieren, dass eine Entität in der Rolle eines SNMP-Agents agiert. Eine Anwendung ruft diese Funktion auch auf, um die Implementierung darüber zu informieren, wenn eine Entität nicht mehr in dieser Rolle agiert. Die SnmpListen-Funktion ist ein Element der WinSNMP-API, Version 2.0.

Syntax

SNMPAPI_STATUS SNMPAPI_CALL SnmpListen(
  [in] HSNMP_ENTITY   hEntity,
  [in] SNMPAPI_STATUS lStatus
);

Parameter

[in] hEntity

Handle an die WinSNMP-Entität, um zu benachrichtigen, wenn die Microsoft WinSNMP-Implementierung eine eingehende SNMP-Anforderungsnachricht (PDU) empfängt. Dieser Parameter identifiziert die Agentanwendung. Weitere Informationen finden Sie in den folgenden Abschnitten "Hinweise" und "Rückgabewerte".

Wenn Sie die SnmpCreateSession-Funktion aufrufen, können Sie angeben, ob die Implementierung eine Fensterbenachrichtigung oder eine SNMPAPI_CALLBACK-Funktion verwenden soll, um die Anwendung zu benachrichtigen, wenn eine SNMP-Nachricht oder ein asynchrones Ereignis verfügbar ist.

[in] lStatus

Gibt eine variable Lange Ganzzahl ohne Vorzeichen an, die angibt, ob die winSNMP-Entität, die durch den hEntity-Parameter identifiziert wird, in einer SNMP-Agentrolle fungiert oder ob sie nicht mehr in dieser Rolle agiert. Dieser Parameter kann einen der folgenden Werte annehmen.

Wert	Bedeutung
SNMPAPI_ON	Die angegebene WinSNMP-Entität funktioniert in einer Agentrolle.
SNMPAPI_OFF	Die angegebene WinSNMP-Entität funktioniert nicht in einer Agentrolle.

Das Übergeben des Werts SNMPAPI_OFF gibt sowohl die der Entität zugeordneten Ressourcen als auch den ihr zugewiesenen Port frei. Weitere Informationen finden Sie im folgenden Abschnitt "Hinweise".

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 Speicherbelegung ist ein Fehler aufgetreten.
SNMPAPI_ENTITY_INVALID	Der hEntity-Parameter ist ungültig. Dieser Parameter muss ein Handle sein, das von einem vorherigen Aufruf der SnmpStrToEntity-Funktion zurückgegeben wurde.
SNMPAPI_MODE_INVALID	Der lStatus-Parameter ist ungültig.
SNMPAPI_NOOP	Die durch den hEntity-Parameter angegebene Entität funktioniert bereits in der Rolle eines SNMP-Agents.
SNMPAPI_TL_RESOURCE_ERROR	Es liegt ein Fehler auf der Netzwerktransportebene vor. Für die durch den hEntity-Parameter angegebene Entität konnte kein Socket erstellt werden.
SNMPAPI_TL_OTHER	Fehler in der Netzwerktransportebene beim Versuch, einen Socket für die durch den hEntity-Parameter angegebene Entität zu binden.
SNMPAPI_OTHER_ERROR	Es ist ein unbekannter oder nicht definierter Fehler aufgetreten.

Hinweise

Wenn Sie eine Entität angeben, geben Sie explizit die Adressfamilie, die Schnittstellenadresse und den Port für die Entität an. Dies liegt daran, dass WinSNMP diese Attribute jeder WinSNMP-Entität als Ergebnis eines Aufrufs der SnmpStrToEntity-Funktion zuweist. Die Implementierung verwendet die Adress- und Porteinstellungen, die derzeit der durch den hEntity-Parameter angegebenen Entität zugewiesen sind, wenn sie Benachrichtigungen an die Agentanwendung sendet. Weitere Informationen finden Sie unter SnmpSetPort.

Wenn Sie die SnmpClose-Funktion für eine WinSNMP-Sitzung und die SnmpCleanup-Funktion für eine WinSNMP-Anwendung aufrufen, müssen Sie alle Ports freigeben, die WinSNMP-Agentanwendungen zugeordnet sind.

Weitere Informationen zu SNMP-Verwaltungsanwendungen und Agentanwendungen finden Sie unter Registrieren einer SNMP-Agent-Anwendung und Informationen zu SNMP.

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