SnmpGetTimeout-Funktion (winsnmp.h)

[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-SnmpGetTimeout-Funktion gibt den Timeoutwert in hundertstel Sekunden für die Übertragung von SNMP-Nachrichtenanforderungen zurück. Der Timeoutwert gilt für Aufrufe, die eine WinSNMP-Anwendung an die SnmpSendMsg-Funktion für eine angegebene Verwaltungsentität sendet.

Syntax

SNMPAPI_STATUS SNMPAPI_CALL SnmpGetTimeout(
  [in]  HSNMP_ENTITY   hEntity,
  [out] smiLPTIMETICKS nPolicyTimeout,
  [out] smiLPTIMETICKS nActualTimeout
);

Parameter

[in] hEntity

Handle an die Zielverwaltungsentität von Interesse.

[out] nPolicyTimeout

Zeiger auf eine ganzzahlige Variable, um den Timeoutwert in hundertstel Sekunden 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] nActualTimeout

Zeiger auf eine ganzzahlige Variable, um das letzte tatsächliche oder geschätzte Antwortintervall für die Zielentität zu empfangen, 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 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, und geben Sie einen NULL-Wert im Sitzungsparameter an. 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.
SNMPAPI_NOOP
Die Parameter nPolicyRetry und nActualRetry sind beide NULL. Der Vorgang wurde nicht ausgeführt.
SNMPAPI_OTHER_ERROR
Es ist ein unbekannter oder nicht definierter Fehler aufgetreten.

Hinweise

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

Der Timeoutzeitraum ist das Intervall zwischen dem Aufruf der SnmpSendMsg-Funktion der Anwendung und dem Aufruf der SnmpRecvMsg-Funktion .

Eine WinSNMP-Anwendung kann den Timeoutwert mit einem Aufruf der SnmpSetTimeout-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

SnmpSetTimeout

WinSNMP-Funktionen

Übersicht über winSNMP-API