IBdnRouter::EnumRoute

[This is preliminary documentation and subject to change.]

The EnumRoute method returns a list of the routes used by the MMR.

Syntax

HRESULT EnumRoute(
  DWORD dwFlags, 
  BDN_IP_ADDRESS baIPAddress, 
  DWORD dwVifID, 
  DWORD dwReservationID, 
  DWORD * pdwRouteCnt, 
  BDN_ROUTE ** pbrRouteList
);
 

Parameters

dwFlags

Flags to tell the MMR what kinds of routes to return. The possible flags are:

BDN_ROUTE_ALL

Return all routes created by the calling application.

BDN_ROUTE_VIF

Return all routes that use a specific VIF.

BDN_ROUTE_IP_ADDRESS

Return all routes using a specific IP address.

BDN_ROUTE_RESV

Return all routes using a specific reservation ID.

baIPAddress

IP address to match if the BDN_ROUTE_IP_ADDRESS flags is set.

dwVifID

ID of the VIF to match is the BDN_ROUTE_VIF flag is set.

dwReservationID

ID of the bandwidth reservation to match if the BDN_ROUTE_RESV flag is set.

pdwRouteCnt

Pointer to a variable that receives the number of routes returned.

pbrRouteList

Pointer to a variable that receives a pointer to the list of routes.

Return Value

Returns S_OK if the MMR successfully returns a list of routes.

Remarks

The calling routine is responsible for freeing the memory used to hold the list of routes returned by this function using the function CoTaskMemFree.

Note that the EnumRoute method only returns routes created by in the current process.

See Also

IBdnRouter::CreateRoute