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

A WinSNMP application calls the SnmpCancelMsg function to request that the Microsoft WinSNMP implementation cancel retransmission attempts and time-out notifications for an SNMP request message. The SnmpCancelMsg function is an element of the WinSNMP API, version 2.0.

Syntax

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

Parameters

[in] session

Handle to the WinSNMP session that submitted the SNMP request message (PDU) to be canceled.

[in] reqId

Specifies a unique numeric value that identifies the PDU of interest. This parameter must match the request identifier (request_id) of the PDU parameter specified in the application's initial call to the SnmpSendMsg function.

Return value

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. The SnmpGetLastError function can return one of the following errors.

Remarks

Calling the SnmpCancelMsg function is equivalent to calling the SnmpSetRetransmitMode function, for a specific SNMP message, with the retransmission mode equal to SNMPAPI_OFF.

For more information, see Canceling Retransmission and Managing the Retransmission Policy.

Requirements

See also

SnmpSendMsg

SnmpSetRetransmitMode

WinSNMP Functions

WinSNMP API Overview