rtmv2.h header
This header is used by Routing and Remote Access Service. For more information, see:
rtmv2.h contains the following programming interfaces:
RTM_IPV4_GET_ADDR_AND_LEN The RTM_IPV4_GET_ADDR_AND_LEN macro converts a generic net address and length to an IPv4 RTM_NET_ADDRESS structure and length. |
RTM_IPV4_GET_ADDR_AND_MASK The RTM_IPV4_GET_ADDR_AND_MASK macro converts to a generic RTM_NET_ADDRESS structure and length to an IPv4 address and mask. |
RTM_IPV4_LEN_FROM_MASK The RTM_IPV4_LEN_FROM_MASK macro converts an IPv4 mask to a generic route length. |
RTM_IPV4_MAKE_NET_ADDRESS The RTM_IPV4_MAKE_NET_ADDRESS macro converts an IPv4 address and a length to a generic RTM_NET_ADDRESS structure. |
RTM_IPV4_MASK_FROM_LEN The RTM_IPV4_MASK_FROM_LEN macro converts a generic route length to an IPv4 mask. |
RTM_IPV4_SET_ADDR_AND_LEN The RTM_IPV4_SET_ADDR_AND_LEN macro converts an IPv4 address and a length to a generic RTM_NET_ADDRESS structure. |
RTM_IPV4_SET_ADDR_AND_MASK The RTM_IPV4_SET_ADDR_AND_MASK macro converts an IPv4 address and mask to a generic RTM_NET_ADDRESS structure. |
RTM_SIZE_OF_DEST_INFO The RTM_SIZE_OF_DEST_INFO macro returns the size of the destination information structure (RTM_DEST_INFO). |
RTM_SIZE_OF_ROUTE_INFO The RTM_SIZE_OF_ROUTE_INFO macro returns the size of the route information structure, RTM_ROUTE_INFO. |
RtmAddNextHop The RtmAddNextHop function adds a new next-hop entry or updates an existing next-hop entry to a client's next-hop list. |
RtmAddRouteToDest The RtmAddRouteToDest function adds a new route to the routing table or updates an existing route in the routing table. If the best route changes, a change notification is generated. |
RtmBlockMethods The RtmBlockMethods function blocks or unblocks the execution of methods for a specified destination, route, or next hop, or for all destinations, routes, and next hops. |
RtmCreateDestEnum The RtmCreateDestEnum function starts an enumeration of the destinations in the routing table. A client can enumerate destinations for one or more views, or for all views. |
RtmCreateNextHopEnum The RtmCreateNextHopEnum enumerates the next hops in the next-hop list. |
RtmCreateRouteEnum The RtmCreateRouteEnum function creates an enumeration of the routes for a particular destination or range of destinations in the routing table. A client can enumerate routes for one or more views, or for all views. |
RtmCreateRouteList The RtmCreateRouteList function creates a list in which the caller can keep a copy of the routes it owns. |
RtmCreateRouteListEnum The RtmCreateRouteListEnum function creates an enumeration of routes on the specified route list. |
RtmDeleteEnumHandle The RtmDeleteEnumHandle function deletes the specified enumeration handle and frees all resources allocated for the enumeration. |
RtmDeleteNextHop The RtmDeleteNextHop function deletes a next hop from the next-hop list. |
RtmDeleteRouteList The RtmDeleteRouteList function removes all routes from a client-specific route list, then frees any resources allocated to the list. |
RtmDeleteRouteToDest The RtmDeleteRouteToDest function deletes a route from the routing table and updates the best-route information for the corresponding destination, if the best route changed. If the best route changes, a change notification is generated. |
RtmDeregisterEntity The RtmDeregisterEntity function unregisters a client from a routing table manager instance and address family. |
RtmDeregisterFromChangeNotification The RtmDeregisterFromChangeNotification function unregisters a client from change notification and frees all resources allocated to the notification. |
RtmFindNextHop The RtmFindNextHop function finds a specific next hop in a client's next-hop list. |
RtmGetChangedDests The RtmGetChangedDests function returns a set of destinations with changed information. |
RtmGetChangeStatus The RtmGetChangeStatus function checks whether there are pending changes that have not been retrieved with RtmGetChangedDests. |
RtmGetDestInfo The RtmGetDestInfo function returns information about a destination. |
RtmGetEntityInfo The RtmGetEntityInfo function returns information about a previously registered client. |
RtmGetEntityMethods The RtmGetEntityMethods function queries the specified client to determine which methods are available for another client to invoke. |
RtmGetEnumDests The RtmGetEnumDests function retrieves the next set of destinations in the specified enumeration. |
RtmGetEnumNextHops The RtmGetEnumNextHops function retrieves the next set of next hops in the specified enumeration. |
RtmGetEnumRoutes The RtmGetEnumRoutes function retrieves the next set of routes in the specified enumeration. |
RtmGetExactMatchDestination The RtmGetExactMatchDestination function searches the routing table for a destination that exactly matches the specified network address and subnet mask. If an exact match is found, the information for that destination is returned. |
RtmGetExactMatchRoute The RtmGetExactMatchRoute function searches the routing table for a route that exactly matches the specified route. |
RtmGetLessSpecificDestination The RtmGetLessSpecificDestination function searches the routing table for a destination with the next-best-match (longest) prefix, given a destination prefix. The requested destination information is returned. |
RtmGetListEnumRoutes The RtmGetListEnumRoutes function enumerates a set of routes in a specified route list. |
RtmGetMostSpecificDestination The RtmGetMostSpecificDestination function searches the routing table for a destination with the exact match for a specified network address and subnet mask; if the exact match is not found, the best prefix is matched. |
RtmGetNextHopInfo The RtmGetNextHopInfo function returns information about the specified next hop. |
RtmGetNextHopPointer The RtmGetNextHopPointer function obtains a direct pointer to the specified next hop. The pointer allows the next-hop owner direct read access to the routing table manager's RTM_NEXTHOP_INFO structure. |
RtmGetOpaqueInformationPointer The RtmGetOpaqueInformationPointer function returns a pointer to the opaque information field in a destination that is reserved for this client. |
RtmGetRegisteredEntities The RtmGetRegisteredEntities function returns information about all clients that have registered with the specified instance of the routing table manager and specified address family. |
RtmGetRouteInfo The RtmGetRouteInfo function returns information for the specified route. |
RtmGetRoutePointer The RtmGetRoutePointer function obtains a direct pointer to a route that allows the owner of the route read access. |
RtmHoldDestination The RtmHoldDestination function marks a destination to be put in the hold-down state for a certain amount of time. A hold down only happens if the last route for the destination in any view is deleted. |
RtmIgnoreChangedDests The RtmIgnoreChangedDests function skips the next change for each destination if it has already occurred. |
RtmInsertInRouteList The RtmInsertInRouteList function inserts the specified set of routes into the client's route list. If a route is already in another list, the route is removed from the old list and inserted into the new one. |
RtmInvokeMethod The RtmInvokeMethod function invokes a method exported by another client. |
RtmIsBestRoute The RtmIsBestRoute function returns the set of views in which the specified route is the best route to a destination. |
RtmIsMarkedForChangeNotification The RtmIsMarkedForChangeNotification function queries the routing table manager to determine if a destination has previously been marked by a call to RtmMarkDestForChangeNotification. |
RtmLockDestination The RtmLockDestination function locks or unlocks a destination in the routing table. Use this function to protect a destination while changing opaque pointers. |
RtmLockNextHop The RtmLockNextHop function locks or unlocks a next hop. This function should be called by the next hop's owner to lock the next hop before making changes to the next hop. A pointer to the next hop is returned. |
RtmLockRoute The RtmLockRoute function locks or unlocks a route in the routing table. This protects the route while a client makes the necessary changes to the opaque route pointers owned by the client. |
RtmMarkDestForChangeNotification The RtmMarkDestForChangeNotification function marks a destination for a client. |
RtmReferenceHandles The RtmReferenceHandles function increases the reference count for objects pointed to by one or more handles that the routing manager used to access those objects. |
RtmRegisterEntity The RtmRegisterEntity function registers a client with an instance of the routing table manager for a specific address family. |
RtmRegisterForChangeNotification The RtmRegisterForChangeNotification function informs the routing table manager that the client should receive change notifications for the specified types of changes. |
RtmReleaseChangedDests The RtmReleaseChangedDests function releases the changed destination handles. |
RtmReleaseDestInfo The RtmReleaseDestInfo function releases a destination structure. |
RtmReleaseDests The RtmReleaseDests function releases the destination handles. |
RtmReleaseEntities The RtmReleaseEntities function releases the client handles returned by RtmGetRegisteredEntities. |
RtmReleaseEntityInfo The RtmReleaseEntityInfo function releases a client structure. |
RtmReleaseNextHopInfo The RtmReleaseNextHopInfo function releases a next-hop structure. |
RtmReleaseNextHops The RtmReleaseNextHops function releases the next-hop handles. |
RtmReleaseRouteInfo The RtmReleaseRouteInfo function releases a route structure. |
RtmReleaseRoutes The RtmReleaseRoutes function releases the route handles. |
RtmUpdateAndUnlockRoute The RtmUpdateAndUnlockRoute function updates the position of the route in the set of routes for a destination, and adjusts the best route information for the destination. |
_ENTITY_METHOD The RTM_ENTITY_EXPORT_METHOD callback is the prototype for any method exported by a client. |
_EVENT_CALLBACK The RTM_EVENT_CALLBACK callback is used by the routing table manager to inform a client that the specified event occurred. |
RTM_DEST_INFO The RTM_DEST_INFO structure is used to exchange destination information with clients registered with the routing table manager. |
RTM_ENTITY_EXPORT_METHODS The RTM_ENTITY_EXPORT_METHODS structure contains the set of methods exported by a client. |
RTM_ENTITY_ID The RTM_ENTITY_ID structure is used to uniquely identify a client to the routing table manager. The protocol identifier and the instance identifier are the values that are used to uniquely identify a client. |
RTM_ENTITY_INFO The RTM_ENTITY_INFO structure is used to exchange client information with the routing table manager. |
RTM_ENTITY_METHOD_INPUT The RTM_ENTITY_METHOD_INPUT structure is used to pass information to a client when invoking its method. |
RTM_ENTITY_METHOD_OUTPUT The RTM_ENTITY_METHOD_OUTPUT structure is used to pass information to the calling client when the routing table manager invokes a method. |
RTM_NET_ADDRESS The RTM_NET_ADDRESS structure is used to communicate address information to the routing table manager for any address family. The address family must use only with contiguous address masks that are less than 8 bytes. |
RTM_NEXTHOP_INFO The RTM_NEXTHOP_INFO structure is used to exchange next-hop information with the routing table manager. |
RTM_NEXTHOP_LIST The RTM_NEXTHOP_LIST structure contains a list of next hops used to determine equal-cost paths in a route. |
RTM_PREF_INFO The RTM_PREF_INFO structure contains the information used when comparing any two routes. The value of the Preference member is given more weight than the value of the Metric member. |
RTM_REGN_PROFILE The RTM_REGN_PROFILE structure contains information returned during the registration process. The information is used for later function calls (such as the maximum number of routes that can be returned by a call to RtmGetEnumRoutes). |
RTM_ROUTE_INFO The RTM_ROUTE_INFO structure is used to exchange route information with the routing table manager. Do not change the read-only information. |
RTM_EVENT_TYPE The RTM_EVENT_TYPE enumeration enumerates the events that the routing table manager can notify the client about using the RTM_EVENT_CALLBACK callback. |