Routing and Remote Access Service

Overview of the Routing and Remote Access Service technology.

To develop Routing and Remote Access Service, you need these headers:

For programming guidance for this technology, see:

Enumerations

Title Description
MGM_ENUM_TYPES The MGM_ENUM_TYPES enumeration lists the types of group enumerations that the multicast group manager uses. This structure is used by the MgmGroupEnumerationStart function.
MPRAPI_OBJECT_TYPE Specifies the structure type in a MPRAPI_OBJECT_HEADER structure.
RAS_HARDWARE_CONDITION The RAS_HARDWARE_CONDITION enumeration type specifies hardware status information about a given RAS port.
RAS_PORT_CONDITION The RAS_PORT_CONDITION enumerated type specifies information regarding the connection condition of a given RAS port.
RAS_QUARANTINE_STATE The RAS_QUARANTINE_STATE enumerated type indicates the quarantine state of a client connection.
RASPROJECTION_INFO_TYPE Is used in the RAS_PROJECTION_INFO structure to represent either a RASPPP_PROJECTION_INFO or RASIKEV2_PROJECTION_INFO structure.
ROUTER_CONNECTION_STATE Enumerates the possible states of an interface on a router.
ROUTER_INTERFACE_TYPE The ROUTER_INTERFACE_TYPE type enumerates the different kinds of interfaces on a router.
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.

Functions

Title Description
_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.
MgmAddGroupMembershipEntry The MgmAddGroupMembershipEntry function notifies the multicast group manager that there are new receivers for the specified groups on the specified interface.
MgmDeleteGroupMembershipEntry The MgmDeleteGroupMembershipEntry function notifies the multicast group manager that there are no more receivers present for the specified groups on the specified interface.
MgmDeRegisterMProtocol The MgmDeRegisterMProtocol function deregisters a client handle obtained from a call to MgmRegisterMProtocol.
MgmGetFirstMfe The MgmGetFirstMfe function retrieves MFEs starting at the beginning of the MFE list.
MgmGetFirstMfeStats The MgmGetFirstMfeStats function retrieves MFE statistics starting at the beginning of the MFE list.
MgmGetMfe The MgmGetMfe function retrieves a specific MFE.
MgmGetMfeStats The MgmGetMfeStats function retrieves the statistics for a specific MFE. The statistics returned include the packets received, bytes received, and the packets forwarded on each outgoing interface.
MgmGetNextMfe The MgmGetNextMfe function retrieves one or more MFEs.
MgmGetNextMfeStats The MgmGetNextMfeStats function retrieves one or more sets of MFE statistics.
MgmGetProtocolOnInterface The MgmGetProtocolOnInterface function retrieves the protocol ID of the multicast routing protocol that owns the specified interface.
MgmGroupEnumerationEnd The MgmGroupEnumerationEnd function releases the specified enumeration handle that was obtained from a previous call to MgmGroupEnumerationStart.
MgmGroupEnumerationGetNext The MgmGroupEnumerationGetNext function retrieves the next set of group entries. The information that is returned by this function is a list of groups joined and the sources requested, if any.
MgmGroupEnumerationStart The MgmGroupEnumerationStart function obtains an enumeration handle that is later used to obtain the list of groups that have been joined. After the client obtains the handle, it should use the MgmGroupEnumerationGetNext function to enumerate the groups.
MgmRegisterMProtocol The MgmRegisterMProtocol function is used by clients to register with the multicast group manager.
MgmReleaseInterfaceOwnership The MgmReleaseInterfaceOwnership function is used by a client to relinquish ownership of an interface. When this function is called, all MFEs maintained by the multicast group manager on behalf of the client and for the specified interface are deleted.
MgmSetMfe The MgmSetMfe function changes the upstream neighbor for an MFE. An MFE contains the information about which interface is receiving and which interfaces are forwarding multicast data.
MgmTakeInterfaceOwnership The MgmTakeInterfaceOwnership function is called by a client (such as a routing protocol) when it is enabled on an interface.
MprAdminAcceptNewConnection Remote Access Service calls the MprAdminAcceptNewConnection function each time a new user dials in and successfully completes RAS authentication. MprAdminAcceptNewConnection determines whether the user is allowed to connect.
MprAdminAcceptNewConnection2 Remote Access Service calls the MprAdminAcceptNewConnection2 function each time a new user dials in and successfully completes RAS authentication. MprAdminAcceptNewConnection2 determines whether the user is allowed to connect.
MprAdminAcceptNewConnection3 Remote Access Service calls the MprAdminAcceptNewConnection3 function each time a new user dials in and successfully completes RAS authentication. MprAdminAcceptNewConnection3 determines whether the user is allowed to connect.
MprAdminAcceptNewConnectionEx Remote Access Service (RAS) calls the MprAdminAcceptNewConnectionEx function each time a new user dials in and successfully completes a RAS authentication. MprAdminAcceptNewConnectionEx determines whether the user is allowed to connect.
MprAdminAcceptNewLink Remote Access Service (RAS) calls the MprAdminAcceptNewLink function each time a link is created for a particular connection.
MprAdminAcceptReauthentication Remote Access Service calls the MprAdminAcceptReauthentication function whenever the quarantine state of the client changes.
MprAdminAcceptReauthenticationEx Remote Access Service (RAS) calls the MprAdminAcceptReauthenticationEx function whenever the quarantine state of the client changes.
MprAdminBufferFree The MprAdminBufferFree function frees memory buffers returned by _MprAdminDeviceEnum, MprAdminInterfaceGetInfo, MprAdminInterfaceDeviceGetInfo, MprAdminInterfaceEnum, MprAdminServerGetInfo, MprAdminInterfaceTransportGetInfo, and MprAdminTransportGetInfo.
MprAdminConnectionClearStats The MprAdminConnectionClearStats function resets the statistics counters for the specified connection.
MprAdminConnectionEnum The MprAdminConnectionEnum function enumerates all active connections.
MprAdminConnectionEnumEx The MprAdminConnectionEnumEx function enumerates the active connections for a specified RRAS server.
MprAdminConnectionGetInfo Retrieves data about a specific connection.
MprAdminConnectionGetInfoEx Retrieves the connection information for a specific connection on a specified RRAS server.
MprAdminConnectionHangupNotification Remote Access Service calls the MprAdminConnectionHangupNotification function after the last link for the specified connection has been dismantled.
MprAdminConnectionHangupNotification2 Remote Access Service calls the MprAdminConnectionHangupNotification2 function after the last link for the specified connection has been dismantled.
MprAdminConnectionHangupNotification3 Remote Access Service calls the MprAdminConnectionHangupNotification3 function after the last link for the specified connection has been dismantled.
MprAdminConnectionHangupNotificationEx Remote Access Service (RAS) calls the MprAdminConnectionHangupNotificationEx function after the last link for the specified connection has been dismantled.
MprAdminConnectionRemoveQuarantine The MprAdminConnectionRemoveQuarantine function removes quarantine filters on a dialed-in RAS client if the filters were applied as a result of Internet Authentication Service (IAS) policies.
MprAdminDeregisterConnectionNotification The MprAdminDeregisterConnectionNotification function deregisters an event object that was previously registered using MprAdminRegisterConnectionNotification. Once deregistered, this event is no longer signaled when an interface connects or disconnects.
MprAdminDeviceEnum Function is called to enumerate RAS capable devices installed on the computer that can return their name and type.
MprAdminEstablishDomainRasServer The MprAdminEstablishDomainRasServer function establishes the given machine as a Remote Access Server in the domain. This function must be executed only on a machine joined to a domain.
MprAdminGetErrorString The MprAdminGetErrorString function returns the string associated with a router error from Mprerror.h.
MprAdminGetIpAddressForUser RAS calls the MprAdminGetIpAddressForUser function once for each user that requires an IP address.
MprAdminGetIpv6AddressForUser RAS calls the MprAdminGetIpv6AddressForUser function once for each user that requires an IPv6 address.
MprAdminGetPDCServer The MprAdminGetPDCServer function retrieves the name of the server with the master User Accounts Subsystem (UAS) from either a domain name or a server name. Either the domain name parameter or the server name parameter may be NULL, but not both.
MprAdminInitializeDll When the Routing and Remote Access Service (RRAS) starts, it calls the MprAdminInitializeDll function that is exported by the administration DLL. Use this function to perform any required initialization for the DLL.
MprAdminInitializeDllEx When the Routing and Remote Access Service (RRAS) starts, it calls the MprAdminInitializeDll function that is exported by the administration DLL.
MprAdminInterfaceConnect The MprAdminInterfaceConnect function creates a connection to the specified WAN interface.
MprAdminInterfaceCreate The MprAdminInterfaceCreate function creates an interface on a specified server.
MprAdminInterfaceDelete The MprAdminInterfaceDelete function deletes an interface on a specified server.
MprAdminInterfaceDeviceGetInfo The MprAdminInterfaceDeviceGetInfo retrieves information about a device that is used in a router demand-dial interface.
MprAdminInterfaceDeviceSetInfo The MprAdminInterfaceDeviceSetInfo creates or modifies a device that is used in a router demand-dial interface.
MprAdminInterfaceDisconnect The MprAdminInterfaceDisconnect function disconnects a connected WAN interface.
MprAdminInterfaceEnum The MprAdminInterfaceEnum function enumerates all the interfaces on a specified server.
MprAdminInterfaceGetCredentials Use the MprAdminInterfaceGetCredentials function to retrieve the domain, user name, and password for dialing out on the specified demand-dial interface.
MprAdminInterfaceGetCredentialsEx Use the MprAdminInterfaceGetCredentialsEx function to retrieve extended credentials information for the specified interface. Use this function to retrieve credentials information used for Extensible Authentication Protocols (EAPs).
MprAdminInterfaceGetCustomInfoEx Retrieves tunnel-specific configuration for a specified demand dial interface on a specified server.
MprAdminInterfaceGetHandle The MprAdminInterfaceGetHandle function retrieves a handle to a specified interface.
MprAdminInterfaceGetInfo The MprAdminInterfaceGetInfo function retrieves information for a specified interface on a specified server.
MprAdminInterfaceQueryUpdateResult The MprAdminInterfaceQueryUpdateResult function returns the result of the last request to a specified router manager to update its routes for an interface. For more information, see MprAdminInterfaceUpdateRoutes.
MprAdminInterfaceSetCredentials Use MprAdminInterfaceSetCredentials function to set the domain, user name, and password that will be used for dialing out on the specified demand-dial interface.
MprAdminInterfaceSetCredentialsEx Use the MprAdminInterfaceSetCredentialsEx function to set extended credentials information for an interface. Use this function to set credentials information used for Extensible Authentication Protocols (EAPs).
MprAdminInterfaceSetCustomInfoEx Sets the tunnel specific custom configuration for a specified demand dial interface on a specified server.
MprAdminInterfaceSetInfo The MprAdminInterfaceSetInfo function sets information for a specified interface on a specified server.
MprAdminInterfaceTransportAdd The MprAdminInterfaceTransportAdd function adds a transport (for example, IP or IPX) to a specified interface.
MprAdminInterfaceTransportGetInfo The MprAdminInterfaceTransportGetInfo function retrieves information about a transport running on a specified interface.
MprAdminInterfaceTransportRemove The MprAdminInterfaceTransportRemove function removes a transport (for example, IP or IPX) from a specified interface.
MprAdminInterfaceTransportSetInfo The MprAdminInterfaceTransportSetInfo function sets information for a transport running on a specified interface.
MprAdminInterfaceUpdatePhonebookInfo The MprAdminInterfaceUpdatePhonebookInfo function forces the router to pick up changes made on a specified demand-dial interface. Call this function after changes are made to a phone-book entry for a demand-dial interface.
MprAdminInterfaceUpdateRoutes The MprAdminInterfaceUpdateRoutes function requests a specified router manager to update its routing information for a specified interface.
MprAdminIsDomainRasServer The MprAdminIsDomainRasServer function returns information regarding whether the given machine is registered as the remote access server in the domain.
MprAdminIsServiceInitialized The MprAdminIsServiceInitialized function checks whether the RRAS service is running on a specified server if the calling process has access.
MprAdminIsServiceRunning The MprAdminIsServiceRunning function checks whether the RRAS service is running on a specified server if the calling process has access.
MprAdminLinkHangupNotification RAS calls the MprAdminLinkHangupNotification function whenever a link for a particular connection is dismantled.
MprAdminMIBBufferFree The MprAdminMIBBufferFree function frees buffers returned by the following functions MprAdminMIBEntryGet, MprAdminMIBEntryGetFirst, MprAdminMIBEntryGetNext
MprAdminMIBEntryCreate The MprAdminMIBEntryCreate function creates an entry for one of the variables exported by a routing protocol or router manager.
MprAdminMIBEntryDelete The MprAdminMIBEntryDelete function deletes an entry for one of the variables exported by a routing protocol or router manager.
MprAdminMIBEntryGet The MprAdminMIBEntryGet function retrieves the value of one of the variables exported by a routing protocol or router manager.
MprAdminMIBEntryGetFirst The MprAdminMIBEntryGetFirst function retrieves the first variable of some set of variables exported by a protocol or router manager. The module that services the call defines first.
MprAdminMIBEntryGetNext The MprAdminMIBEntryGetNext function retrieves the next variable of some set of variables exported by a protocol or router manager. The module that services the call defines next.
MprAdminMIBEntrySet The MprAdminMIBEntrySet function sets the value of one of the variables exported by a routing protocol or router manager.
MprAdminMIBGetTrapInfo The MprAdminMIBGetTrapInfo function queries the module that set a trap event for more information about the trap.
MprAdminMIBServerConnect The MprAdminMIBServerConnect function establishes a connection to the router being administered. This call should be made before any other calls to the server. The handle returned by this function is used in subsequent MIB calls.
MprAdminMIBServerDisconnect The MprAdminMIBServerDisconnect function disconnects the connection made by a previous call to MprAdminMIBServerConnect.
MprAdminMIBSetTrapInfo The MprAdminMIBSetTrapInfo function specifies a handle to an event that is signaled whenever a TRAP needs to be issued.
MprAdminPortClearStats The MprAdminPortClearStats function resets the statistics for the specified port.
MprAdminPortDisconnect The MprAdminPortDisconnect function disconnects a connection on a specific port.
MprAdminPortEnum Enumerates all active ports in a specific connection, or all ports available for use or currently used by RAS.
MprAdminPortGetInfo The MprAdminPortGetInfo function gets information for a specific port.
MprAdminPortReset The MprAdminPortReset function resets the communication device attached to the specified port.
MprAdminRegisterConnectionNotification The MprAdminRegisterConnectionNotification function registers an event object with the Demand Dial Manager (DDM) so that, if an interface connects or disconnects, the event is signaled.
MprAdminReleaseIpAddress The MprAdminReleaseIpAddress function is called when a user disconnects and the user's IP address is about to be released.
MprAdminReleaseIpv6AddressForUser The MprAdminReleaseIpv6AddressForUser function is called once for each user that needs to release an IPv6 address.
MprAdminSendUserMessage The MprAdminSendUserMessage function sends a message to the user connected on the specified connection.
MprAdminServerConnect The MprAdminServerConnect function establishes a connection to a router for the purpose of administering that router.
MprAdminServerDisconnect The MprAdminServerDisconnect function disconnects the connection made by a previous call to MprAdminServerConnect.
MprAdminServerGetCredentials The MprAdminServerGetCredentials function retrieves the pre-shared key for the specified server.
MprAdminServerGetInfo The MprAdminServerGetInfo function retrieves information about the specified RRAS server.
MprAdminServerGetInfoEx The MprAdminServerGetInfoEx function retrieves port information about the specified RRAS server.
MprAdminServerSetCredentials The MprAdminServerSetCredentials functions sets the pre-shared key for the specified server.
MprAdminServerSetInfo The MprAdminServerSetInfo function is used to set the number of ports for L2TP, PPTP, and SSTP devices when the RRAS service is running.
MprAdminServerSetInfoEx The MprAdminServerSetInfoEx function sets port information on a specified RRAS server.
MprAdminTerminateDll When the RAS shuts down, it calls the MprAdminTerminateDll function exported by the administration DLL. Use this function to perform any required clean-up for the DLL.
MprAdminTransportCreate The MprAdminTransportCreate function loads a new transport, and starts the router manager for the transport.
MprAdminTransportGetInfo The MprAdminTransportGetInfo function retrieves global information, default client interface information, or both, for a specified transport.
MprAdminTransportSetInfo The MprAdminTransportSetInfo function sets global information, or default client interface information, or both, for a specified transport.
MprAdminUserGetInfo The MprAdminUserGetInfo function retrieves all RAS information for a particular user.
MprAdminUserSetInfo The MprAdminUserSetInfo function sets RAS information for the specified user.
MprConfigBufferFree The MprConfigBufferFree function frees buffers. MprConfigXEnum, MprConfigXGetInfo
MprConfigFilterGetInfo Returns static filtering information for a specified transport protocol type.
MprConfigFilterSetInfo Sets the static filtering information for a specified transport protocol type.
MprConfigGetFriendlyName The MprConfigGetFriendlyName function returns the friendly name for an interface that corresponds to the specified GUID name.
MprConfigGetGuidName The MprConfigGetGuidName function returns the GUID name for an interface that corresponds to the specified friendly name.
MprConfigInterfaceCreate The MprConfigInterfaceCreate function creates a router interface in the specified router configuration.
MprConfigInterfaceDelete The MprConfigInterfaceDelete function removes a router interface from the router configuration. All transport information associated with this interface is also removed.
MprConfigInterfaceEnum The MprConfigInterfaceEnum function enumerates the interfaces that are configured for the router.
MprConfigInterfaceGetCustomInfoEx Retrieves the custom IKEv2 policy configuration for the specified interface.
MprConfigInterfaceGetHandle The MprConfigInterfaceGetHandle function retrieves a handle to the specified interface's configuration in the specified router configuration.
MprConfigInterfaceGetInfo The MprConfigInterfaceGetInfo function retrieves the configuration for the specified interface from the router.
MprConfigInterfaceSetCustomInfoEx Sets the custom IKEv2 policy configuration for the specified interface.
MprConfigInterfaceSetInfo The MprConfigInterfaceSetInfo function sets the configuration for the specified interface.
MprConfigInterfaceTransportAdd The MprConfigInterfaceTransportAdd function adds a transport protocol to an interface configuration on the router.
MprConfigInterfaceTransportEnum The MprConfigInterfaceTransportEnum function enumerates the transports configured on the specified interface.
MprConfigInterfaceTransportGetHandle The MprConfigInterfaceTransportGetHandle function retrieves a handle to the transport configuration of an interface in the specified router configuration.
MprConfigInterfaceTransportGetInfo The MprConfigInterfaceTransportGetInfo function retrieves the configuration information for the specified client on the specified interface.
MprConfigInterfaceTransportRemove The MprConfigInterfaceTransportRemove function removes the specified transport from the specified interface configuration on the router.
MprConfigInterfaceTransportSetInfo The MprConfigInterfaceTransportSetInfo function updates the configuration information for the client on the specified interface and transport protocol.
MprConfigServerBackup The MprConfigServerBackup function creates a backup of the router-manager, interface, and phone-book configuration for the router.
MprConfigServerConnect The MprConfigServerConnect function connects to the router to be configured.
MprConfigServerDisconnect The MprConfigServerDisconnect function disconnects a connection made by a previous call to MprConfigServerConnect.
MprConfigServerGetInfo The MprConfigServerGetInfo function retrieves server-level configuration information for the specified router.
MprConfigServerGetInfoEx The MprConfigServerGetInfoEx function retrieves port information for a specified server.
MprConfigServerInstall The MprConfigServerInstall function configures Routing and Remote Access Service with a default configuration.
MprConfigServerRestore The MprConfigServerRestore function restores the router-manager, interface, and phone-book configuration from a backup created by a previous call to MprConfigServerBackup.
MprConfigServerSetInfo The MprConfigServerSetInfo function is used to set the port count for L2TP, PPTP, and SSTP ports and enable or disable RRAS on them in the registry when the RRAS service is not running so that it is picked up next time the system restarts.
MprConfigServerSetInfoEx The MprConfigServerSetInfoEx function sets port information on a specified RRAS server.
MprConfigTransportCreate The MprConfigTransportCreate function adds the specified transport to the list of transport protocols present in the specified router configuration.
MprConfigTransportDelete The MprConfigTransportDelete function removes the specified transport from the list of transports present in the specified router configuration.
MprConfigTransportEnum The MprConfigTransportEnum function enumerates the transports configured on the router.
MprConfigTransportGetHandle The MprConfigTransportGetHandle function retrieves a handle to the specified transport protocol's configuration in the specified router configuration.
MprConfigTransportGetInfo The MprConfigTransportGetInfo function retrieves the configuration for the specified transport protocol from the router.
MprConfigTransportSetInfo The MprConfigTransportSetInfo function changes the configuration for the specified transport protocol in the specified router configuration.
MprInfoBlockAdd The MprInfoBlockAdd function creates a new header that is identical to an existing header with the addition of a new block.
MprInfoBlockFind The MprInfoBlockFind function locates a specified block in an information header, and retrieves information about the block.
MprInfoBlockQuerySize The MprInfoBlockQuerySize function returns the returns the size of the information header.
MprInfoBlockRemove The MprInfoBlockRemove function creates a new header that is identical to an existing header with a specified block removed.
MprInfoBlockSet The MprInfoBlockSet creates a new header that is identical to an existing header with a specified block modified.
MprInfoCreate The MprInfoCreate function creates a new information header.
MprInfoDelete The MprInfoDelete function deletes an information header created using MprInfoCreate, or retrieved by MprInfoBlockAdd, MprInfoBlockRemove, or MprInfoBlockSet.
MprInfoDuplicate The MprInfoDuplicate function duplicates an existing information header.
MprInfoRemoveAll The MprInfoRemoveAll function removes all information blocks from the specified header.
ORASADFUNC The ORASADFunc function is an application-defined callback function that is used to provide a customized user interface for autodialing.
PADD_INTERFACE The AddInterface function adds an interface to be managed by the routing protocol.
PBLOCK_CONVERT_SERVICES_TO_STATIC The BlockConvertServicesToStatic function converts all services received on a specified interface to static.
PBLOCK_DELETE_STATIC_SERVICES The BlockDeleteStaticServices function deletes all static services associated with a specified interface.
PCLOSE_SERVICE_ENUMERATION_HANDLE The CloseServiceEnumerationHandle function terminates the enumeration and frees associated resources.
PCONNECT_CLIENT The router manager calls the ConnectClient function when a client connects to an interface on which the routing protocol is running.
PCREATE_SERVICE_ENUMERATION_HANDLE The CreateServiceEnumerationHandle function returns a handle that allows the use of fast and change-tolerant enumeration functions.
PCREATE_STATIC_SERVICE The CreateStaticService function adds a static service to the table.
PDELETE_INTERFACE The DeleteInterface function removes an interface from the set managed by the routing protocol.
PDELETE_STATIC_SERVICE The DeleteStaticService function deletes a static service from the table.
PDISCONNECT_CLIENT The router manager calls the DisconnectClient function when a client disconnects from an interface on which the routing protocol is running.
PDO_UPDATE_ROUTES The DoUpdateRoutes function requests the routing protocol to perform a routing information update over the specified interface to obtain static route information.
PENUMERATE_GET_NEXT_SERVICE The EnumerateGetNextService function returns the next service entry in an enumeration started by CreateServiceEnumerationHandle.
PFNRASFREEBUFFER The custom-scripting DLL calls RasFreeBuffer to release a memory buffer that was allocated by a previous call to RasGetBuffer.
PFNRASGETBUFFER The custom-scripting DLL calls RasGetBuffer to allocate memory for sending or receiving data over the port connected to the server.
PFNRASRECEIVEBUFFER The custom-scripting DLL calls the RasReceiveBuffer function to inform RAS that it is ready to receive data from the server over the specified port.
PFNRASRETRIEVEBUFFER The custom-scripting DLL calls the RasRetrieveBuffer function to obtain data received from the RAS server over the specified port.
PFNRASSENDBUFFER The custom-scripting DLL calls the RasSendBuffer function to send data to the server over the specified port.
PFNRASSETCOMMSETTINGS Call RasSetCommSettings from a custom-scripting DLL to change the settings on the port for the connection.
PFNRASSETCOMMSETTINGS Call RasSetCommSettings from a custom-scripting DLL to change the settings on the port for the connection.
PGET_EVENT_MESSAGE The GetEventMessage function gets an entry from the routing protocol's message queue. The routing protocol uses the queue to inform the router manager of asynchronous events.
PGET_FIRST_ORDERED_SERVICE The GetFirstOrderedService function returns the first service in the specified order from the designated subset of services in the table.
PGET_GLOBAL_INFO The GetGlobalInfo function retrieves global (as opposed to interface-specific) configuration information kept by the routing protocol.
PGET_INTERFACE_INFO The GetInterfaceInfo function gets the configuration information kept by the routing protocol for a specific interface.
PGET_MFE_STATUS The router manager calls the GetMfeStatus function to obtain the status of the multicast forwarding entry (MFE) for the specified interface, group address, and source address.
PGET_NEIGHBORS The router manager calls the GetNeighbors function to obtain the querier for the network attached through the specified interface.
PGET_NEXT_ORDERED_SERVICE The GetNextOrderedService function returns the next service from a subset of services in the table. The service returned is the next service after a given input service using the ordering method specified.
PGET_SERVICE_COUNT The GetServiceCount function returns the number of services in the table.
PINTERFACE_STATUS Router manager calls the InterfaceStatus function to change the status of an interface.
PIS_SERVICE The IsService function checks whether a service of specified type and name exists in the service table, and optionally returns the service's parameters.
PMGM_CREATION_ALERT_CALLBACK The PMGM_CREATION_ALERT_CALLBACK callback is a call into a routing protocol. This call determines the subset of interfaces owned by the routing protocol on which a multicast packet from a new source should be forwarded.
PMGM_DISABLE_IGMP_CALLBACK The PMGM_DISABLE_IGMP_CALLBACK callback is a call into IGMP to notify it that a routing protocol is taking or releasing ownership of an interface on which IGMP is enabled.
PMGM_ENABLE_IGMP_CALLBACK The PMGM_ENABLE_IGMP_CALLBACK callback is a call into IGMP to notify it that a routing protocol has finished taking or releasing ownership of an interface.
PMGM_JOIN_ALERT_CALLBACK The PMGM_JOIN_ALERT_CALLBACK callback is a call into a routing protocol to notify the protocol that new receivers are present for one or more groups on interfaces that are owned by other routing protocols.
PMGM_LOCAL_JOIN_CALLBACK The PMGM_LOCAL_JOIN_CALLBACK callback is a call into a routing protocol to notify the protocol that IGMP has detected new receivers for a group on an interface that is currently owned by the routing protocol.
PMGM_LOCAL_LEAVE_CALLBACK The PMGM_LOCAL_LEAVE_CALLBACK callback is a call into a routing protocol to notify the routing protocol that the IGMP has detected that it no longer has receivers for a group on an interface that is currently owned by the routing protocol.
PMGM_PRUNE_ALERT_CALLBACK The PMGM_PRUNE_ALERT_CALLBACK callback is a call into a routing protocol to notify the protocol that receivers are no longer present on interfaces owned by other routing protocols.
PMGM_RPF_CALLBACK The PMGM_RPF_CALLBACK callback is a call into a routing protocol to determine if a given packet was received on the correct interface.
PMGM_WRONG_IF_CALLBACK The PMGM_WRONG_IF_CALLBACK is a call into a routing protocol to notify the protocol that a packet has been received from the specified source and for the specified group on the wrong interface.
PMIB_CREATE The MibCreate function passes an SNMP MIB-style Create Request to the routing protocol.
PMIB_DELETE The MibDelete function passes an SNMP MIB-style Delete Request to the routing protocol.
PMIB_GET The MibGet function passes an SNMP MIB-style Get Request to the routing protocol DLL.
PMIB_GET_FIRST The MibGetFirst function passes a SNMP MIB-style Get First Request to the routing protocol.
PMIB_GET_NEXT The MibGetNext function passes a SNMP MIB-style Get Next Request to the routing protocol.
PMIB_GET_TRAP_INFO The MibGetTrapInfo function queries the module that set a trap event for more information about the trap.
PMIB_SET The MibSet function passes a SNMP MIB-style Set Request to the routing protocol.
PMIB_SET_TRAP_INFO The MibSetTrapInfo function passes in a handle to an event which is signaled whenever a TRAP needs to be issued.
PQUERY_POWER The QueryPower function is reserved for future use.
PREGISTER_PROTOCOL The RegisterProtocol function registers the routing protocol with the router manager. It also informs the router manager of the functionality that the routing protocol supports.
PSET_GLOBAL_INFO The SetGlobalInfo function sets the global (as opposed to interface-specific) configuration information kept by the routing protocol. The format of this information is specific to the routing protocol.
PSET_INTERFACE_INFO The SetInterfaceInfo function sets the configuration of a specific interface managed by the routing protocol.
PSET_POWER The SetPower function is reserved for future use.
PSTART_COMPLETE Router Manager calls the StartComplete function to inform the routing protocol that initialization is complete and all interfaces have been added. The routing protocol should wait for this call before starting any protocol-specific behavior.
PSTART_PROTOCOL The StartProtocol function initializes the routing protocol's functionality.
PSTOP_PROTOCOL The StopProtocol function causes the routing protocol to perform an orderly shutdown.
RASADFUNCA The RASADFunc function is an application-defined callback function that is used to provide a customized user interface for autodialing.
RASADFUNCW The RASADFunc function is an application-defined callback function that is used to provide a customized user interface for autodialing.
RasClearConnectionStatistics The RasClearConnectionStatistics functions clears any accumulated statistics for the specified RAS connection.
RasClearLinkStatistics The RasClearLinkStatistics functions clears any accumulated statistics for the specified link in a RAS multilink connection.
RasConnectionNotificationA The RasConnectionNotification function specifies an event object that the system sets to the signaled state when a RAS connection is created or terminated.
RasConnectionNotificationW The RasConnectionNotification function specifies an event object that the system sets to the signaled state when a RAS connection is created or terminated.
RasCreatePhonebookEntryA The RasCreatePhonebookEntry function creates a new phone-book entry. The function displays a dialog box in which the user types information for the phone-book entry.
RasCreatePhonebookEntryW The RasCreatePhonebookEntry function creates a new phone-book entry. The function displays a dialog box in which the user types information for the phone-book entry.
RasCustomDeleteEntryNotifyFn The RasCustomDeleteEntryNotify function is an application-defined function that is exported by a third-party custom-dialing DLL. This function allows third-party vendors to implement custom dialogs for managing phone-book entries.
RasCustomDialDlgFn The RasCustomDialDlg function is an application-defined function that is exported by a third-party custom-dialing DLL. This function allows third-party vendors to implement custom RAS connection dialog boxes.
RasCustomDialFn The RasCustomDial function is an application-defined function that is exported by a third-party custom-dialing DLL. This function allows third-party vendors to implement custom remote-access dialing routines.
RasCustomEntryDlgFn The RasCustomEntryDlg function is an application-defined function that is exported by a third-party custom-dialing DLL. This function allows third-party vendors to implement custom dialogs for managing phone-book entries.
RasCustomHangUpFn The RasCustomHangUp function is an application-defined function that is exported by a third-party custom-dialing DLL. This function allows third-party vendors to implement custom connection hang-up routines.
RasCustomScriptExecuteFn RAS calls the RasCustomScriptExecute function when establishing a connection for a phone-book entry that has the RASEO_CustomScript option set.
RasDeleteEntryA The RasDeleteEntry function deletes an entry from a phone book.
RasDeleteEntryW The RasDeleteEntry function deletes an entry from a phone book.
RasDeleteSubEntryA The RasDeleteSubEntry function deletes the specified subentry from the specified phone-book entry.
RasDeleteSubEntryW The RasDeleteSubEntry function deletes the specified subentry from the specified phone-book entry.
RasDialA The RasDial function establishes a RAS connection between a RAS client and a RAS server. The connection data includes callback and user-authentication information.
RasDialDlgA The RasDialDlg function establishes a RAS connection using a specified phone-book entry and the credentials of the logged-on user. The function displays a stream of dialog boxes that indicate the state of the connection operation.
RasDialDlgW The RasDialDlg function establishes a RAS connection using a specified phone-book entry and the credentials of the logged-on user. The function displays a stream of dialog boxes that indicate the state of the connection operation.
RASDIALFUNC The RasDialFunc callback function is called by the RasDial function when a change of state occurs during a RAS connection process.
RASDIALFUNC The RasDialFunc callback function is called by the RasDial function when a change of state occurs during a RAS connection process.
RASDIALFUNC1 A RasDialFunc1 function is called by the RasDial function when a change of state occurs during a remote access connection process.
RASDIALFUNC1 A RasDialFunc1 function is called by the RasDial function when a change of state occurs during a remote access connection process.
RASDIALFUNC2 A RasDialFunc2 callback function is called by the RasDial function calls when a change of state occurs during a remote access connection process.
RASDIALFUNC2 A RasDialFunc2 callback function is called by the RasDial function calls when a change of state occurs during a remote access connection process.
RasDialW The RasDial function establishes a RAS connection between a RAS client and a RAS server. The connection data includes callback and user-authentication information.
RasEditPhonebookEntryA The RasEditPhonebookEntry function edits an existing phone-book entry. The function displays a dialog box in which the user can modify the existing information.
RasEditPhonebookEntryW The RasEditPhonebookEntry function edits an existing phone-book entry. The function displays a dialog box in which the user can modify the existing information.
RasEntryDlgA The RasEntryDlg function displays modal property sheets that allow a user to manipulate phone-book entries.
RasEntryDlgW The RasEntryDlg function displays modal property sheets that allow a user to manipulate phone-book entries.
RasEnumAutodialAddressesA The RasEnumAutodialAddresses function returns a list of all addresses in the AutoDial mapping database.
RasEnumAutodialAddressesW The RasEnumAutodialAddresses function returns a list of all addresses in the AutoDial mapping database.
RasEnumConnectionsA The RasEnumConnections function lists all active RAS connections. It returns each connection's handle and phone-book entry name.
RasEnumConnectionsW The RasEnumConnections function lists all active RAS connections. It returns each connection's handle and phone-book entry name.
RasEnumDevicesA The RasEnumDevices function returns the name and type of all available RAS-capable devices.
RasEnumDevicesW The RasEnumDevices function returns the name and type of all available RAS-capable devices.
RasEnumEntriesA The RasEnumEntries function lists all entry names in a remote access phone book.
RasEnumEntriesW The RasEnumEntries function lists all entry names in a remote access phone book.
RasFreeEapUserIdentityA Use the RasFreeEapUserIdentity function to free the memory buffer returned by RasGetEapUserIdentity.
RasFreeEapUserIdentityW Use the RasFreeEapUserIdentity function to free the memory buffer returned by RasGetEapUserIdentity.
RasGetAutodialAddressA The RasGetAutodialAddress function retrieves information about all the AutoDial entries associated with a network address in the AutoDial mapping database.
RasGetAutodialAddressW The RasGetAutodialAddress function retrieves information about all the AutoDial entries associated with a network address in the AutoDial mapping database.
RasGetAutodialEnableA The RasGetAutodialEnable function indicates whether the AutoDial feature is enabled for a specified TAPI dialing location.
RasGetAutodialEnableW The RasGetAutodialEnable function indicates whether the AutoDial feature is enabled for a specified TAPI dialing location.
RasGetAutodialParamA The RasGetAutodialParam function retrieves the value of an AutoDial parameter.
RasGetAutodialParamW The RasGetAutodialParam function retrieves the value of an AutoDial parameter.
RasGetConnectionStatistics The RasGetConnectionStatistics function retrieves accumulated connection statistics for the specified connection.
RasGetConnectStatusA The RasGetConnectStatus function retrieves information on the current status of the specified remote access connection. An application can use this call to determine when an asynchronous RasDial call is complete.
RasGetConnectStatusW The RasGetConnectStatus function retrieves information on the current status of the specified remote access connection. An application can use this call to determine when an asynchronous RasDial call is complete.
RasGetCountryInfoA The RasGetCountryInfo function retrieves country/region-specific dialing information from the Windows Telephony list of countries/regions.
RasGetCountryInfoW The RasGetCountryInfo function retrieves country/region-specific dialing information from the Windows Telephony list of countries/regions.
RasGetCredentialsA The RasGetCredentials function retrieves the user credentials associated with a specified RAS phone-book entry.
RasGetCredentialsW The RasGetCredentials function retrieves the user credentials associated with a specified RAS phone-book entry.
RasGetCustomAuthDataA Use the RasGetCustomAuthData function to retrieve connection-specific authentication information. This information is not specific to a particular user.
RasGetCustomAuthDataW Use the RasGetCustomAuthData function to retrieve connection-specific authentication information. This information is not specific to a particular user.
RasGetEapUserDataA Use the RasGetEapUserData function to retrieve user-specific Extensible Authentication Protocol (EAP) information for the specified phone-book entry.
RasGetEapUserDataW Use the RasGetEapUserData function to retrieve user-specific Extensible Authentication Protocol (EAP) information for the specified phone-book entry.
RasGetEapUserIdentityA The RasGetEapUserIdentity function retrieves identity information for the current user. Use this information to call RasDial with a phone-book entry that requires Extensible Authentication Protocol (EAP).
RasGetEapUserIdentityW The RasGetEapUserIdentity function retrieves identity information for the current user. Use this information to call RasDial with a phone-book entry that requires Extensible Authentication Protocol (EAP).
RasGetEntryDialParamsA The RasGetEntryDialParams function retrieves the connection information saved by the last successful call to the RasDial or RasSetEntryDialParams function for a specified phone-book entry.
RasGetEntryDialParamsW The RasGetEntryDialParams function retrieves the connection information saved by the last successful call to the RasDial or RasSetEntryDialParams function for a specified phone-book entry.
RasGetEntryPropertiesA The RasGetEntryProperties function retrieves the properties of a phone-book entry.
RasGetEntryPropertiesW The RasGetEntryProperties function retrieves the properties of a phone-book entry.
RasGetErrorStringA The RasGetErrorString function obtains an error message string for a specified RAS error value.
RasGetErrorStringW The RasGetErrorString function obtains an error message string for a specified RAS error value.
RasGetLinkStatistics The RasGetLinkStatistics function retrieves accumulated statistics for the specified link in a RAS multilink connection.
RasGetNapStatus Retrieves the Network Access Protection (NAP) connection state variables for a given remote access connection.
RasGetProjectionInfoA The RasGetProjectionInfo function obtains information about a remote access projection operation for a specified remote access component protocol.
RasGetProjectionInfoEx Obtains information about Point-to-Point Protocol (PPP) or Internet Key Exchange version 2 (IKEv2) remote access projection operations for all RAS connections on the local client.
RasGetProjectionInfoW The RasGetProjectionInfo function obtains information about a remote access projection operation for a specified remote access component protocol.
RasGetSubEntryHandleA The RasGetSubEntryHandle function retrieves a connection handle for a specified subentry of a multilink connection.
RasGetSubEntryHandleW The RasGetSubEntryHandle function retrieves a connection handle for a specified subentry of a multilink connection.
RasGetSubEntryPropertiesA The RasGetSubEntryProperties function retrieves information about a subentry for a specified phone-book entry.
RasGetSubEntryPropertiesW The RasGetSubEntryProperties function retrieves information about a subentry for a specified phone-book entry.
RasHangUpA The RasHangUp function terminates a remote access connection. The connection is specified with a RAS connection handle. The function releases all RASAPI32.DLL resources associated with the handle.
RasHangUpW The RasHangUp function terminates a remote access connection. The connection is specified with a RAS connection handle. The function releases all RASAPI32.DLL resources associated with the handle.
RasInvokeEapUI The RasInvokeEapUI function displays a custom user interface to obtain Extensible Authentication Protocol (EAP) information from the user.
RASPBDLGFUNCA The RasPBDlgFunc function is an application-defined callback function that receives notifications of user activity while the RasPhonebookDlg dialog box is open.
RASPBDLGFUNCW The RasPBDlgFunc function is an application-defined callback function that receives notifications of user activity while the RasPhonebookDlg dialog box is open.
RasPhonebookDlgA The RasPhonebookDlg function displays the main Dial-Up Networking dialog box.
RasPhonebookDlgW The RasPhonebookDlg function displays the main Dial-Up Networking dialog box.
RasRenameEntryA The RasRenameEntry function changes the name of an entry in a phone book.
RasRenameEntryW The RasRenameEntry function changes the name of an entry in a phone book.
RasSecurityDialogBegin The RasSecurityDialogBegin function is a third-party RAS security DLL entry point that the RAS server calls when a remote user tries to connect. This enables the security DLL to begin its authentication of the remote user.
RasSecurityDialogComplete The RasSecurityDialogComplete function notifies the RAS server of the results of a third-party security authentication transaction.
RasSecurityDialogEnd The RasSecurityDialogEnd function is a third-party RAS security DLL entry point that the RAS server calls to terminate an authentication transaction.
RasSecurityDialogGetInfo The RasSecurityDialogGetInfo function is called by a RAS security DLL to get information about a port from the RAS server.
RasSecurityDialogReceive The RasSecurityDialogReceive function starts an asynchronous operation that receives a remote user's response to a security challenge.
RasSecurityDialogSend The RasSecurityDialogSend function sends a message to be displayed in a terminal window on a remote computer. A third-party RAS security DLL sends this message as part of its authentication of a remote user.
RasSetAutodialAddressA The RasSetAutodialAddress function can add an address to the AutoDial mapping database. Alternatively, the function can delete or modify the data associated with an existing address in the database.
RasSetAutodialAddressW The RasSetAutodialAddress function can add an address to the AutoDial mapping database. Alternatively, the function can delete or modify the data associated with an existing address in the database.
RasSetAutodialEnableA The RasSetAutodialEnable function enables or disables the AutoDial feature for a specified TAPI dialing location.
RasSetAutodialEnableW The RasSetAutodialEnable function enables or disables the AutoDial feature for a specified TAPI dialing location.
RasSetAutodialParamA The RasSetAutodialParam function sets the value of an AutoDial parameter.
RasSetAutodialParamW The RasSetAutodialParam function sets the value of an AutoDial parameter.
RasSetCredentialsA Sets the user credentials associated with a specified RAS phone-book entry.
RasSetCredentialsW Sets the user credentials associated with a specified RAS phone-book entry.
RasSetCustomAuthDataA Use the RasSetCustomAuthData function to set connection-specific authentication information. This information should not be specific to a particular user.
RasSetCustomAuthDataW Use the RasSetCustomAuthData function to set connection-specific authentication information. This information should not be specific to a particular user.
RasSetEapUserDataA Use the RasSetEapUserData function to store user-specific Extensible Authentication Protocol (EAP) information for the specified phone-book entry in the registry.
RasSetEapUserDataW Use the RasSetEapUserData function to store user-specific Extensible Authentication Protocol (EAP) information for the specified phone-book entry in the registry.
RasSetEntryDialParamsA The RasSetEntryDialParams function changes the connection information saved by the last successful call to the RasDial or RasSetEntryDialParams function for a specified phone-book entry.
RasSetEntryDialParamsW The RasSetEntryDialParams function changes the connection information saved by the last successful call to the RasDial or RasSetEntryDialParams function for a specified phone-book entry.
RasSetEntryPropertiesA The RasSetEntryProperties function changes the connection information for an entry in the phone book or creates a new phone-book entry.
RasSetEntryPropertiesW The RasSetEntryProperties function changes the connection information for an entry in the phone book or creates a new phone-book entry.
RasSetSubEntryPropertiesA The RasSetSubEntryProperties function creates a new subentry or modifies an existing subentry of a specified phone-book entry.
RasSetSubEntryPropertiesW The RasSetSubEntryProperties function creates a new subentry or modifies an existing subentry of a specified phone-book entry.
RasUpdateConnection The RasUpdateConnection function updates the tunnel endpoints of an Internet Key Exchange version 2 (IKEv2) connection.
RasValidateEntryNameA The RasValidateEntryName function validates the format of a connection entry name. The name must contain at least one non-white-space alphanumeric character.
RasValidateEntryNameW The RasValidateEntryName function validates the format of a connection entry name. The name must contain at least one non-white-space alphanumeric character.
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.

Structures

Title Description
AUTH_VALIDATION_EX Used for enabling clients to bypass Point-to-Point (PPP) authentication during Secure Socket Tunneling Protocol (SSTP) connection establishment.
IKEV2_CONFIG_PARAMS Used to get or set parameters for Internet Key Exchange version 2 (IKEv2) devices (RFC 4306).
IKEV2_PROJECTION_INFO Contains information obtained during Internet Key Exchange (IKE) negotiation.
IKEV2_PROJECTION_INFO2 Contains information obtained during Internet Key Exchange (IKE) negotiation.
IKEV2_TUNNEL_CONFIG_PARAMS1 Used to get or set tunnel parameters for Internet Key Exchange version 2 (IKEv2) devices.
IKEV2_TUNNEL_CONFIG_PARAMS2 Gets or sets tunnel parameters for Internet Key Exchange version 2 (IKEv2) devices.
IP_ADAPTER_BINDING_INFO The IP_ADAPTER_BINDING_INFO structure contains IP-specific information for a particular network adapter.
IP_LOCAL_BINDING The IP_LOCAL_BINDING structure contains IP address information for an adapter.
IPV6_ADAPTER_BINDING_INFO The IPV6_ADAPTER_BINDING_INFO structure contains IPv6-specific information for a particular network adapter.
IPV6_LOCAL_BINDING The IPV6_LOCAL_BINDING structure contains IPv6 address information for an adapter.
IPX_IF_INFO The IPX_IF_INFO structure stores information for an IPX interface.
IPX_SERVER_ENTRY The IPX_SERVER_ENTRY structure describes a particular IPX service.
IPX_SERVICE The IPX_SERVICE structure contains information about an IPX service, and identifies the interface and protocol through which this information was obtained.
IPXWAN_IF_INFO The IPXWAN_IF_INFO structure stores the administrative state for an IPX WAN interface.
L2TP_CONFIG_PARAMS0 Used to get and set the device configuration for Layer 2 Tunneling Protocool (L2TP) on a RAS Server.
L2TP_CONFIG_PARAMS1 Used to get and set the device configuration for Layer 2 Tunneling Protocool (L2TP) on a RAS Server.
MESSAGE The MESSAGE union contains information about an event reported to the router manager through the routing protocol's message queue.
MGM_IF_ENTRY The MGM_IF_ENTRY structure describes a router interface.
MPR_CREDENTIALSEX_0 The MPR_CREDENTIALSEX_0 structure contains extended credentials information such as the information used by Extensible Authentication Protocols (EAPs).
MPR_CREDENTIALSEX_1 The MPR_CREDENTIALSEX_1 structure contains a pre-shared key used by a demand-dial interface.
MPR_DEVICE_0 The MPR_DEVICE_0 structure stores information about a device used for a link in a multilinked demand dial interface.
MPR_DEVICE_1 The MPR_DEVICE_1 structure stores information about a device used for a link in a multilinked demand dial interface. In addition to the information in MPR_DEVICE_0, MPR_DEVICE_1 contains phone-number information.
MPR_FILTER_0 Contains static filter configuration information.
MPR_IF_CUSTOMINFOEX0 Gets or sets tunnel specific custom configuration for a demand dial interfaces.
MPR_IFTRANSPORT_0 The MPR_IFTRANSPORT_0 structure contains information for a particular interface transport.
MPR_INTERFACE_0 The MPR_INTERFACE_0 structure contains information for a particular router interface.
MPR_INTERFACE_1 The MPR_INTERFACE_1 structure contains configuration and status information for a particular router interface.
MPR_INTERFACE_2 Contains data for a router demand-dial interface.
MPR_INTERFACE_3 Contains data for a router demand-dial interface.
MPR_SERVER_0 The MPR_SERVER_0 structure is used to retrieve information about a device.
MPR_SERVER_1 Is used to retrieve and set the number of ports available for the Point-to-Point Tunneling Protocol (PPTP) and Layer 2 Tunneling Protocol (L2TP) on a device.
MPR_SERVER_2 Is used to retrieve and set the number of ports available for the Point-to-Point Tunneling Protocol (PPTP), Layer 2 Tunneling Protocol (L2TP), and Secure Socket Tunneling Protocol (SSTP) on a device.
MPR_SERVER_EX0 Used to get or set the configuration of a RAS server.
MPR_SERVER_EX1 Used to get or set the configuration of a RAS server.
MPR_SERVER_SET_CONFIG_EX0 Used to get or set the tunnel configuration information of a RAS server.
MPR_SERVER_SET_CONFIG_EX1 Used to get or set the tunnel configuration information of a RAS server.
MPR_TRANSPORT_0 The MPR_TRANSPORT_0 structure contains information for a particular transport.
MPR40_SERVICE_CHARACTERISTICS The MPR_SERVICE_CHARACTERISTICS structure contains information used to register a routing protocol with the router manager.
MPR50_ROUTING_CHARACTERISTICS The MPR_ROUTING_CHARACTERISTICS structure contains information used to register routing protocols with the router manager.
MPR50_SERVICE_CHARACTERISTICS The MPR_SERVICE_CHARACTERISTICS structure contains information used to register a routing protocol with the router manager.
MPR60_ROUTING_CHARACTERISTICS The MPR_ROUTING_CHARACTERISTICS structure contains information used to register routing protocols with the router manager.
MPRAPI_ADMIN_DLL_CALLBACKS The MPRAPI_ADMIN_DLL_CALLBACKS structure is used by the MprAdminInitializeDllEx function to register the callback function pointers.
MPRAPI_OBJECT_HEADER Defines the structure version for the RAS_CONNECTION_EX, MPR_SERVER_EX, MPR_SERVER_SET_CONFIG_EX, RAS_UPDATE_CONNECTION, AUTH_VALIDATION_EX structures, and the structure version used by the MprAdminConnectionEnumEx method.
MPRAPI_TUNNEL_CONFIG_PARAMS0 Used to get or set configuration of tunnel parameters on a RAS Server.
MPRAPI_TUNNEL_CONFIG_PARAMS1 Used to get or set configuration of tunnel parameters on a RAS Server.
PPP_ATCP_INFO The PPP_ATCP_INFO structure contains the result of a PPP AppleTalk projection operation.
PPP_CCP_INFO The PPP_CCP_INFO structure contains information that describes the results of a Compression Control Protocol (CCP) negotiation.
PPP_INFO The PPP_INFO structure is used to report the results of the various Point-to-Point (PPP) projection operations for a connection.
PPP_INFO_2 The PPP_INFO_2 structure is used to report the results of the various Point-to-Point (PPP) projection operations for a connection.
PPP_INFO_3 The PPP_INFO_3 structure is used to report the results of the various Point-to-Point (PPP) projection operations for a connection.
PPP_IPCP_INFO The PPP_IPCP_INFO structure contains the result of a PPP Internet Protocol (IP) negotiation.
PPP_IPCP_INFO2 The PPP_IPCP_INFO2 structure contains the result of a PPP Internet Protocol (IP) negotiation.
PPP_IPV6_CP_INFO Contains the result of an IPv6 control protocol negotiation.
PPP_IPXCP_INFO The PPP_IPXCP_INFO structure contains the result of a PPP Internetwork Packet Exchange (IPX) projection operation.
PPP_LCP_INFO The PPP_LCP_INFO structure contains information that describes the results of an PPP Link Control Protocol (LCP) negotiation.
PPP_NBFCP_INFO The PPP_NBFCP_INFO structure contains the result of a PPP NetBEUI Framer (NBF) projection operation.
PPP_PROJECTION_INFO Contains information obtained during Point-to-Point (PPP) negotiation for Secure Socket Tunneling Protocol (SSTP), Point-to-Point Tunneling Protocol (PPTP), and Layer 2 Tunneling Protocol (L2TP).
PPP_PROJECTION_INFO2 Contains information obtained during Point-to-Point (PPP) negotiation for Secure Socket Tunneling Protocol (SSTP), Point-to-Point Tunneling Protocol (PPTP), and Layer 2 Tunneling Protocol (L2TP).
PPTP_CONFIG_PARAMS Used to get and set the device configuration for Point-to-Point Tunneling Protocool (PPTP) on a RAS Server.
PROJECTION_INFO Is used in the RAS_CONNECTION_EX structure as a placeholder for the PPP_PROJECTION_INFO and IKEV2_PROJECTION_INFO structures.
PROJECTION_INFO2 Used in the RAS_CONNECTION_4 structure as a placeholder for the PPP_PROJECTION_INFO2 and IKEV2_PROJECTION_INFO2 structures.
RAS_CONNECTION_0 The RAS_CONNECTION_0 structure contains general information regarding a specific connection, such as user name or domain. For more detailed information about a specific connection, such as bytes sent or received, see RAS_CONNECTION_1.
RAS_CONNECTION_1 The RAS_CONNECTION_1 structure contains detailed information regarding a specific connection, such as error counts and bytes received. For more general information about a specific connection, such as user name or domain, see RAS_CONNECTION_0.
RAS_CONNECTION_2 The RAS_CONNECTION_2 structure contains information for a connection, including the Globally Unique Identifier (GUID) that identifies the connection.
RAS_CONNECTION_3 The RAS_CONNECTION_3 structure contains information for the connection, including the Globally Unique Identifier (GUID) that identifies the connection and the quarantine state of the connection.
RAS_CONNECTION_4 Contains specific information for the connection that includes:_the user name, domain, Globally Unique Identifier (GUID) associated with the connection, Network Access Protection (NAP) quarantine state, packet statistics, as well as its Point-to-Point (PPP) and Internet Key Exchange version 2 (IKEv2) related information.
RAS_CONNECTION_EX Contains specific information for the connection that includes:_the user name, domain, and Globally Unique Identifier (GUID) associated with the connection, its Network Access Protection (NAP) quarantine state, its packet statistics, as well as its Point-to-Point(PPP) and Internet Key Exchange version 2 (IKEv2) related information.
RAS_PORT_0 The RAS_PORT_0 structure contains general information regarding a specific RAS port, such as port condition and port name. For more detailed information about a specific port, such as line speed or errors, see RAS_PORT_1.
RAS_PORT_1 The RAS_PORT_1 structure contains detailed information regarding a specific RAS port, such as line speed or errors. For more general information about a port, such as port condition or port name, see RAS_PORT_0.
RAS_PROJECTION_INFO Contains the Point-to-Point (PPP) or Internet Key Exchange version 2 (IKEv2) projection information for a RAS connection.
RAS_SECURITY_INFO The RAS_SECURITY_INFO structure is used with the RasSecurityDialogGetInfo function to return information about the RAS port associated with a RAS security DLL authentication transaction.
RAS_STATS The RAS_STATS structure stores the statistics for a single-link RAS connection, or for one of the links in a multilink RAS connection.
RAS_UPDATE_CONNECTION Used to update an active RAS connection.
RAS_USER_0 The RAS_USER_0 structure contains information for a particular Remote Access Service user.
RAS_USER_1 The RAS_USER_1 structure contains information for a particular Remote Access Service user. The RAS_USER_1 structure is similar to the RAS_USER_0 structure, except that RAS_USER_1 supports an additional member, bfPrivilege2.
RASDEVSPECIFICINFO Used to send a cookie for server validation and bypass point-to-point (PPP) authentication.
RASIKEV2_PROJECTION_INFO Contains projection information obtained during Internet Key Exchange (IKE) negotiation.
RASNAPSTATE The Network Access Protection (NAP) variables for a remote access connection.
RASPPP_PROJECTION_INFO Contains information obtained during Point-to-Point (PPP) negotiation of Internet Protocol version 4 (IPv4) and IPv6 projection operations, and PPP Link Control Protocol (LCP)/multilink, and Compression Control Protocol (CCP) negotiation.
ROUTER_CUSTOM_IKEv2_POLICY0 Contains the IKEv2 main mode and quick mode policy configuration.
ROUTER_IKEv2_IF_CUSTOM_CONFIG0 Gets or sets IKEv2 tunnel configuration parameter for IKEv2 tunnel based demand dial interfaces.
ROUTING_PROTOCOL_CONFIG The ROUTING_PROTOCOL_CONFIG structure describes the routing protocol configuration information that is passed to the multicast group manager when a protocol registers with the multicast group manager.
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.
SECURITY_MESSAGE The SECURITY_MESSAGE structure is used with the RasSecurityDialogComplete function to indicate the results of a RAS security DLL authentication transaction.
SOURCE_GROUP_ENTRY The SOURCE_GROUP_ENTRY structure describes the entry returned by the group enumeration function MgmGroupEnumerationGetNext.
SSTP_CERT_INFO Contains information about a Secure Socket Tunneling Protocool (SSTP) based certificate.
SSTP_CONFIG_PARAMS Used to get and set the device configuration for Secure Socket Tunneling Protocool (SSTP) on a RAS Server.
SUPPORT_FUNCTIONS_50 The SUPPORT_FUNCTIONS structure is used by the router manager to pass the routing protocol a set of pointers to functions provided by the router manager.
SUPPORT_FUNCTIONS_60 The SUPPORT_FUNCTIONS structure is used by the router manager to pass the routing protocol a set of pointers to functions provided by the router manager.
UPDATE_COMPLETE_MESSAGE The UPDATE_COMPLETE_MESSAGE structure contains information describing the completion status of an update operation.