SnmpGetRetry-Funktion (winsnmp.h)

[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 SnmpGetRetry-Funktion gibt den Wert der Wiederholungsanzahl in Einheiten für die erneute Übertragung von SNMP-Nachrichtenanforderungen zurück. Die Wiederholungsanzahl gilt für Aufrufe, die eine WinSNMP-Anwendung an die SnmpSendMsg-Funktion für eine angegebene Verwaltungsentität sendet.

Syntax

SNMPAPI_STATUS SNMPAPI_CALL SnmpGetRetry(
  [in]  HSNMP_ENTITY hEntity,
  [out] smiLPUINT32  nPolicyRetry,
  [out] smiLPUINT32  nActualRetry
);

Parameter

[in] hEntity

Handle an die zielverwaltungsentität von interesse.

[out] nPolicyRetry

Zeiger auf eine Variable ohne Vorzeichen mit langer Ganzzahl, um den Wert der Wiederholungsanzahl für die angegebene Verwaltungsentität zu erhalten. Dies ist ein Wert, den die Microsoft WinSNMP-Implementierung in einer Datenbank speichert. Wenn Sie die in diesem Parameter zurückgegebenen Informationen nicht benötigen, muss nPolicyRetry ein NULL-Zeiger sein.

[out] nActualRetry

Zeiger auf eine Variable ohne Vorzeichen mit langer Ganzzahl, um die letzte tatsächliche oder geschätzte Wiederholungsanzahl für die Zielentität zu erhalten, wie von der Implementierung gemeldet. Wenn Sie die in diesem Parameter zurückgegebenen Informationen nicht benötigen, muss nActualRetry ein NULL-Zeiger sein. Wenn dieser Parameter ein gültiger Zeiger ist, gibt die Funktion 0 zurück. Weitere Informationen finden Sie im 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. Um erweiterte Fehlerinformationen abzurufen, rufen Sie SnmpGetLastError auf, indem Sie einen NULL-Wert im Sitzungsparameter angeben. 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_ENTITY_INVALID
Der hEntity-Parameter ist ungültig.
SNMPAPI_NOOP
Die Parameter nPolicyRetry und nActualRetrysind null. Der Vorgang wurde nicht ausgeführt.
SNMPAPI_OTHER_ERROR
Ein unbekannter oder nicht definierter Fehler ist aufgetreten.

Hinweise

In der Regel ruft eine WinSNMP-Anwendung anstelle einer Agentanwendung die SnmpGetRetry-Funktion auf.

Eine WinSNMP-Anwendung kann den Wert der Wiederholungsanzahl mit einem Aufruf der SnmpSetRetry-Funktion ändern.

Die WinSNMP-Anwendung kann den Wert des nActualRetry-Parameters überwachen und mit dem Wert des nPolicyRetry-Parameters vergleichen, um die Übertragungsleistung zu optimieren. Weitere Informationen finden Sie unter Informationen zur 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

SnmpGetRetransmitMode

SnmpSetRetransmitMode

SnmpSetRetry

WinSNMP-Funktionen

Übersicht über die WinSNMP-API