SnmpMgrGetTrap-Funktion (mgmtapi.h)

Artikel
02/29/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 SnmpMgrGetTrap-Funktion gibt ausstehende Trapdaten zurück, die der Aufrufer nicht empfangen hat, wenn der Trapempfang aktiviert ist. Diese Funktion ist ein Element der SNMP-Verwaltungs-API.

Zusätzlich zu den von dieser Funktion zurückgegebenen Informationen gibt die SnmpMgrGetTrapEx-Funktion die Adresse der Transportquelle und die Communityzeichenfolge der Trap zurück.

Syntax

BOOL SNMP_FUNC_TYPE SnmpMgrGetTrap(
  [out] AsnObjectIdentifier *enterprise,
  [out] AsnNetworkAddress   *IPAddress,
  [out] AsnInteger          *genericTrap,
  [out] AsnInteger          *specificTrap,
  [out] AsnTimeticks        *timeStamp,
  [out] RFC1157VarBindList  *variableBindings
);

Parameter

[out] enterprise

Zeiger auf eine AsnObjectIdentifier-Struktur , um das Unternehmen zu empfangen, das den SNMP-Trap generiert hat.

[out] IPAddress

Zeiger auf eine Variable, um die Adresse des Agents zu empfangen, der die SNMP-Trap generiert hat.

[out] genericTrap

Zeiger auf eine Variable, um einen Indikator der generischen Trap zu empfangen. Dieser Parameter kann einen der folgenden Werte annehmen.

Wert	Bedeutung
SNMP_GENERICTRAP_COLDSTART	Der Agent initialisiert Protokollentitäten im verwalteten Modus. Es kann Objekte in seiner Ansicht ändern.
SNMP_GENERICTRAP_WARMSTART	Der Agent initialisiert sich selbst neu, ändert jedoch keine Objekte in seiner Ansicht.
SNMP_GENERICTRAP_LINKDOWN	Eine angefügte Schnittstelle hat sich vom Status "oben" in den Zustand "down" geändert. Die erste Variable in der Variablenbindungsliste identifiziert die Schnittstelle.
SNMP_GENERICTRAP_LINKUP	Eine angefügte Schnittstelle hat sich vom Zustand "down" in den Status "up" geändert. Die erste Variable in der Variablenbindungsliste identifiziert die Schnittstelle.
SNMP_GENERICTRAP_AUTHFAILURE	Eine SNMP-Entität hat eine SNMP-Nachricht gesendet, aber sie hat fälschlicherweise behauptet, einer bekannten Community anzugehören.
SNMP_GENERICTRAP_EGPNEIGHLOSS	Ein EGP-Peer hat sich in den Zustand "down" geändert. Die erste Variable in der Variablenbindungsliste identifiziert die IP-Adresse des EGP-Peers.
SNMP_GENERICTRAP_ENTERSPECIFIC	Es ist ein außergewöhnliches Ereignis aufgetreten, das im specificTrap-Parameter mit einem unternehmensspezifischen Wert identifiziert wird.

[out] specificTrap

Zeiger auf eine Variable, um einen Hinweis auf die generierte spezifische Trap zu erhalten.

[out] timeStamp

Zeiger auf eine Variable, um den Zeitstempel zu erhalten.

[out] variableBindings

Zeiger auf eine SnmpVarBindList-Struktur , um die Variablenbindungsliste zu empfangen.

Rückgabewert

Wenn die Funktion eine Trap zurückgibt, ist der Rückgabewert TRUE. Der Code für den Fehler kann abgerufen werden, indem SnmpGetLastError unmittelbar nach dem Aufruf aufgerufen wird.

Sie sollten die SnmpMgrGetTrap-Funktion wiederholt aufrufen, bis false (null) zurückgegeben wird. Die Funktion gibt möglicherweise auch die folgenden Fehlercodes zurück.

Rückgabecode	Beschreibung
SNMP_MGMTAPI_TRAP_ERRORS	Gibt an, dass Fehler aufgetreten sind. Auf Traps kann nicht zugegriffen werden.
SNMP_MGMTAPI_NOTRAPS	Gibt an, dass keine Traps verfügbar sind.
SNMP_MEM_ALLOC_ERROR	Gibt einen Speicherbelegungsfehler an.

Hinweise

Die Anwendung muss immer die SnmpMgrTrapListen-Funktion aufrufen, bevor die SnmpMgrGetTrap-Funktion aufgerufen wird . Dies liegt daran, dass das Ereignishandle, auf das vom phTrapAvailable-Parameter der SnmpMgrTrapListen-Funktion verwiesen wird, die ereignisgesteuerte Erfassung von SNMP-Traps ermöglicht. Die SNMP-Verwaltungs-API signalisiert das Ereignis einer Anwendung, wenn der SNMP-Trap-Dienst eine Trap übermittelt.

Die Anwendung kann auch die SnmpMgrGetTrap-Funktion in regelmäßigen Abständen auf Traps abfragen. In diesem Fall sollte die Anwendung snmpMgrGetTrap wiederholt aufrufen, bis die Funktion 0 (null) zurückgibt.

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	mgmtapi.h
Bibliothek	Mgmtapi.lib
DLL	Mgmtapi.dll

Weitere Informationen

AsnObjectIdentifier

SNMP-Funktionen

Simple Network Management-Protokoll (SNMP) – Übersicht

SnmpMgrTrapListen

SnmpVarBindList

Freigeben über