Função RtmInsertInRouteList (rtmv2.h)
A função RtmInsertInRouteList insere o conjunto de rotas especificado na lista de rotas do cliente. Se uma rota já estiver em outra lista, a rota será removida da lista antiga e inserida na nova.
Sintaxe
DWORD RtmInsertInRouteList(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_ROUTE_LIST_HANDLE RouteListHandle,
[in] UINT NumRoutes,
[in] PRTM_ROUTE_HANDLE RouteHandles
);
Parâmetros
[in] RtmRegHandle
Identificador para o cliente obtido de uma chamada anterior para RtmRegisterEntity.
[in] RouteListHandle
Manipule para a lista de rotas à qual adicionar rotas. Especifique NULL para remover as rotas especificadas de suas listas antigas.
[in] NumRoutes
Especifica o número de rotas em RouteHandles.
[in] RouteHandles
Ponteiro para uma matriz de identificadores de rota a serem movidos da lista antiga para a nova lista.
Retornar valor
Se a função for bem-sucedida, o valor retornado será NO_ERROR.
Se a função falhar, o valor retornado será um dos códigos de erro a seguir.
| Valor | Significado |
|---|---|
|
O manipulador é inválido. |
Comentários
Quando as rotas não forem mais necessárias, libere-as chamando RtmReleaseRoutes.
Para obter o código de exemplo que usa essa função, consulte Usar uma lista de rotas Client-Specific.
Requisitos
| Requisito | Valor |
|---|---|
| Cliente mínimo com suporte | Nenhum compatível |
| Servidor mínimo com suporte | Windows 2000 Server [somente aplicativos da área de trabalho] |
| Plataforma de Destino | Windows |
| Cabeçalho | rtmv2.h |
| Biblioteca | Rtm.lib |
| DLL | Rtm.dll |