SnmpCancelMsg-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.]

Eine WinSNMP-Anwendung ruft die SnmpCancelMsg-Funktion auf, um anzufordern, dass die Microsoft WinSNMP-Implementierung Wiederholungsversuche und Timeoutbenachrichtigungen für eine SNMP-Anforderungsnachricht abbricht. Die SnmpCancelMsg-Funktion ist ein Element der WinSNMP-API, Version 2.0.

Syntax

SNMPAPI_STATUS SNMPAPI_CALL SnmpCancelMsg(
  [in] HSNMP_SESSION session,
  [in] smiINT32      reqId
);

Parameter

[in] session

Behandeln Sie die WinSNMP-Sitzung, die die SNMP-Anforderungsnachricht (PDU) übermittelt hat, um abgebrochen zu werden.

[in] reqId

Gibt einen eindeutigen numerischen Wert an, der die PDU von Interesse identifiziert. Dieser Parameter muss mit dem Anforderungsbezeichner (request_id) des PDU-Parameters übereinstimmen, der im ersten Aufruf der SnmpSendMsg-Funktion der Anwendung angegeben ist.

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_SESSION_INVALID	Der Sitzungsparameter ist ungültig.
SNMPAPI_PDU_INVALID	Der reqId-Parameter identifiziert keine ausstehende Nachricht für die angegebene Sitzung.
SNMPAPI_NOT_INITIALIZED	Die SnmpStartup-Funktion wurde nicht erfolgreich abgeschlossen.
SNMPAPI_ALLOC_ERROR	Während der Speicherzuordnung ist ein Fehler aufgetreten.
SNMPAPI_OTHER_ERROR	Ein unbekannter oder nicht definierter Fehler ist aufgetreten.

Hinweise

Das Aufrufen der SnmpCancelMsg-Funktion entspricht dem Aufrufen der SnmpSetRetransmitMode-Funktion für eine bestimmte SNMP-Nachricht, wobei der Wiederholungsmodus gleich SNMPAPI_OFF.

Weitere Informationen finden Sie unter Abbrechen der erneuten Übertragung und Verwalten der Richtlinie für die erneute Übertragung.

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

Weitere Informationen

SnmpSendMsg

SnmpSetRetransmitMode

WinSNMP-Funktionen

Übersicht über die WinSNMP-API

Freigeben über