SnmpGetTimeout

The WinSNMP SnmpGetTimeout function returns the time-out value, in hundredths of a second, for the transmission of SNMP message requests. The time-out value applies to calls that a WinSNMP application makes to the SnmpSendMsg function for a specified management entity.

SNMPAPI_STATUS SnmpGetTimeout(
  HSNMP_ENTITY hEntity,          // destination management entity 
  smiLPTIMETICKS nPolicyTimeout, // time-out value from the database
  smiLPTIMETICKS nActualTimeout  // last actual or estimated response time
);

Parameters

hEntity

[in] Handle to the destination management entity of interest.

nPolicyTimeout

[out] Pointer to an integer variable to receive the time-out value, in hundredths of a second, for the specified management entity. This is a value that the Microsoft WinSNMP implementation stores in a database. If you do not need the information returned in this parameter, nPolicyTimeout must be a NULL pointer.

nActualTimeout

[out] Pointer to an integer variable to receive the last actual or estimated response interval for the destination entity, as reported by the implementation. If you do not need the information returned in this parameter, nActualTimeout must be a NULL pointer.

Note: This feature has not yet been implemented. If this parameter is a valid pointer, the function returns 0. For additional information, see the following Remarks section.

Return Values

If the function succeeds, the return value is SNMPAPI_SUCCESS.

If the function fails, the return value is SNMPAPI_FAILURE. To get extended error information, call SnmpGetLastError specifying a NULL value in its session parameter. The SnmpGetLastError function can return one of the following errors.

Remarks

Typically a WinSNMP application, rather than an agent application, calls the SnmpGetTimeout function.

The time-out period is the interval between the application's call to the SnmpSendMsg function and its call to the SnmpRecvMsg function.

A WinSNMP application can modify the time-out value with a call to the SnmpSetTimeout function.

The WinSNMP application can monitor the value of the nActualTimeout parameter and compare it to the value of the nPolicyTimeout parameter to optimize transmission performance. For additional information, see About Retransmission and Managing the Retransmission Policy.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in Winsnmp.h.
  Library: Use Wsnmp32.lib.

See Also

WinSNMP API Overview, WinSNMP Functions, SnmpSetTimeout, SnmpSetRetransmitMode, SnmpGetRetransmitMode