SnmpGetRetransmitMode function (winsnmp.h)
[SNMP is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. Instead, use Windows Remote Management, which is the Microsoft implementation of WS-Man.]
The WinSNMP SnmpGetRetransmitMode function returns the current setting of the retransmission mode to a WinSNMP application. The Microsoft WinSNMP implementation uses the retransmission mode to govern transmission time-outs and retransmission attempts on calls to the SnmpSendMsg function.
Syntax
SNMPAPI_STATUS SNMPAPI_CALL SnmpGetRetransmitMode(
[out] smiLPUINT32 nRetransmitMode
);
Parameters
[out] nRetransmitMode
Pointer to an unsigned long integer variable to receive the current retransmission mode in effect for the implementation. This parameter can be one of the following values.
Return value
If the function succeeds, the return value is SNMPAPI_SUCCESS.
If the function fails, the return value is SNMPAPI_FAILURE. If SnmpGetRetransmitMode fails, the value of the nRetransmitMode parameter has no meaning for the application. 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.
| Return code | Description |
|---|---|
|
The SnmpStartup function did not complete successfully. |
|
An error occurred during memory allocation. |
|
An unknown or undefined error occurred. |
Remarks
Typically a WinSNMP application, rather than an agent application, calls the SnmpGetRetransmitMode function. For additional information, see About Retransmission and Managing the Retransmission Policy.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | winsnmp.h |
| Library | Wsnmp32.lib |
| DLL | Wsnmp32.dll |