Função RtmUpdateAndUnlockRoute (rtmv2.h)

A função RtmUpdateAndUnlockRoute atualiza a posição da rota no conjunto de rotas para um destino e ajusta as melhores informações de rota para o destino.

Essa função é usada depois que um cliente bloqueou uma rota e a atualizou diretamente (também conhecida como atualização in-loco).

Sintaxe

DWORD RtmUpdateAndUnlockRoute(
  [in]  RTM_ENTITY_HANDLE       RtmRegHandle,
  [in]  RTM_ROUTE_HANDLE        RouteHandle,
  [in]  ULONG                   TimeToLive,
  [in]  RTM_ROUTE_LIST_HANDLE   RouteListHandle,
  [in]  RTM_NOTIFY_FLAGS        NotifyType,
  [in]  RTM_NOTIFY_HANDLE       NotifyHandle,
  [out] PRTM_ROUTE_CHANGE_FLAGS ChangeFlags
);

Parâmetros

[in] RtmRegHandle

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

[in] RouteHandle

Manipule para a rota a ser alterada.

[in] TimeToLive

Especifica a hora, em milissegundos, após a qual a rota expirou. Especifique INFINITE para impedir que as rotas expirem.

[in] RouteListHandle

Manipule para uma lista de rotas opcional para a qual mover a rota. Esse parâmetro é opcional e pode ser definido como NULL.

[in] NotifyType

Defina esse parâmetro como NULL. NotifyType é reservado para uso futuro.

[in] NotifyHandle

Defina esse parâmetro como NULL. NotifyHandle é reservado para uso futuro.

[out] ChangeFlags

Recebe RTM_ROUTE_CHANGE_BEST se a melhor rota foi alterada.

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 seguintes códigos de erro.

Valor	Significado
ERROR_ACCESS_DENIED	O cliente de chamada não possui essa rota.

Comentários

Antes de chamar essa função, o cliente deve bloquear a rota usando RtmLockRoute, que retorna um ponteiro para a rota. Em seguida, o cliente pode atualizar as informações de rota usando o ponteiro . Por fim, o cliente deve chamar RtmUpdateAndUnlockRoute. Se a função for executada com êxito, a rota será desbloqueada. Se a chamada falhar, o cliente deverá desbloquear a rota chamando RtmLockRoute com o parâmetro LockRoute definido como FALSE.

Para obter o código de exemplo que usa essa função, consulte Atualizar uma rota no local usando RtmUpdateAndUnlockRoute.

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

Confira também

RtmAddRouteToDest

RtmDeleteRouteToDest

RtmGetRoutePointer

RtmHoldDestination

RtmLockRoute