3.6.4.7 GetAddRoutesStatus (Opnum 9)

  • Article

The GetAddRoutesStatus method<31> retrieves packet loss information and status for the Route elements in the Route Collection previously added with the ProcessAddRoutes method.

 HRESULT GetAddRoutesStatus (
   [out] ADD_ROUTES_REPLY* reply
 );

reply: Contains packet loss information and status for Route elements.

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.

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 9.

When processing this call the server MUST do the following:

  • If Route Monitoring State is FALSE, set the routeUnavailable field of the reply data structure to TRUE and return. Otherwise, set the routeUnavailable field of the reply data structure to FALSE.

  • Count the Route elements in Route Collection. Allocate the ADD_ROUTES_REPLY reply data structure such that both the reply.indices and reply.replies arrays contain this many elements. For integer k from 0 to the number of these elements:

    • Locate a Route element r in Route Collection.

    • In an implementation-specific manner, update r.LossAndState.

    • Set reply.indices[k] to r.Index.

    • Set reply.replies[k] to r.LossAndState.

    • Remove element r from Route Collection.

  • Set the Route Monitoring State to FALSE.

Return the following information to the client:

  • The reply data structure.