RtmGetRoutePointer function (rtmv2.h)
The RtmGetRoutePointer function obtains a direct pointer to a route that allows the owner of the route read access.
Syntax
DWORD RtmGetRoutePointer(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_ROUTE_HANDLE RouteHandle,
[out] PRTM_ROUTE_INFO *RoutePointer
);
Parameters
[in] RtmRegHandle
Handle to the client obtained from a previous call to RtmRegisterEntity.
[in] RouteHandle
Handle to the route.
[out] RoutePointer
On input, RoutePointer is a pointer to NULL.
On output, RoutePointer receives a pointer to the route.
Return value
If the function succeeds, the return value is NO_ERROR.
If the function fails, the return value is one of the following error codes.
| Value | Meaning |
|---|---|
|
The calling client does not own this route. |
|
The handle is invalid. |
Remarks
The pointer that was returned points to the public part of the route.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | None supported |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | rtmv2.h |
| Library | Rtm.lib |
| DLL | Rtm.dll |