3.6.4.8 CancelAddRoutesRequest (Opnum 11)

  • Article

The CancelAddRoutesRequest method<32> stops packet loss and status monitoring for Route elements previously added in a ProcessAddRoutes (section 3.6.4.6) invocation and removes these routes from Route Collection.

 HRESULT CancelAddRoutesRequest();

This method has no parameters.

Return Values: A signed 32-bit value that indicates return status. If the method returns a negative value, it has failed. Zero or positive values indicate success, with the lower 16 bits in positive nonzero values containing warnings or flags defined in the method implementation. For more information about Win32 error codes and HRESULT values, see [MS-ERREF] sections 2.1 and 2.2.

Return value/code

Description

0x00000000

S_OK

The call was successful.

0x80004005

E_FAIL

Route Monitoring State is FALSE.

For any other condition, this method MUST return a value that is not one of the values listed in the preceding table. The client MUST behave in one consistent, identical manner for all values that are not listed in the preceding table.

Exceptions Thrown: No exceptions are thrown beyond those thrown by the underlying RPC protocol specified in [MS-RPCE].

The opnum field value for this method is 11.

When processing this call the server MUST do the following:

  • Fail the method with error 0x80004005 (E_FAIL) if Route Monitoring State is FALSE.

  • For each Route element in Route Collection, remove the Route from Route Collection and stop any implementation-specific monitoring of packet loss and status that was initiated with a previous ProcessAddRoutes method.

  • Set Route Monitoring State to FALSE.