Função RtmLockRoute (rtmv2.h)

Artigo
03/01/2024

A função RtmLockRoute bloqueia ou desbloqueia uma rota na tabela de roteamento. Isso protege a rota enquanto um cliente faz as alterações necessárias nos ponteiros de rota opacas pertencentes ao cliente.

Sintaxe

DWORD RtmLockRoute(
  [in]  RTM_ENTITY_HANDLE RtmRegHandle,
  [in]  RTM_ROUTE_HANDLE  RouteHandle,
  [in]  BOOL              Exclusive,
  [in]  BOOL              LockRoute,
  [out] PRTM_ROUTE_INFO   *RoutePointer
);

Parâmetros

[in] RtmRegHandle

Identificador para o cliente obtido de uma chamada anterior para RtmRegisterEntity.

[in] RouteHandle

Manipule para a rota a ser bloqueada.

[in] Exclusive

Especifica se a rota deve ser bloqueada ou desbloqueada em um modo exclusivo (TRUE) ou compartilhado (FALSE).

[in] LockRoute

Especifica se a rota deve ser bloqueada ou desbloqueada. Especifique TRUE para bloquear a rota; especifique FALSE para desbloqueá-lo.

[out] RoutePointer

Se um ponteiro precisar ser retornado: Na entrada, RoutePointer será um ponteiro para NULL. Na saída, se o cliente possuir a rota, o RoutePointer receberá um ponteiro para o próximo salto; caso contrário, RoutePointer permanecerá inalterado.

Se um identificador não precisar ser retornado: na entrada, RoutePointer será NULL.

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
ERROR_ACCESS_DENIED	O cliente de chamada não possui essa rota.
ERROR_INVALID_HANDLE	O manipulador é inválido.

Comentários

Não chame nenhuma outra função RTMv2 até que a rota seja desbloqueada por uma chamada para RtmLockRoute e o parâmetro LockRoute seja definido como FALSE ou uma chamada para RtmUpdateAndUnlockRoute.

Atualmente, essa função bloqueia todo o destino, não apenas a rota.

Os clientes só podem alterar os membros Neighbor, PrefInfo, BelongsToViews, EntitySpecificInfo e NextHopsList da estrutura RTM_ROUTE_INFO .

Se qualquer um desses valores for alterado, o cliente deverá chamar RtmUpdateAndUnlockRoute para notificar o gerenciador de tabelas de roteamento das alterações.

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