Função RtmHoldDestination (rtmv2.h)
A função RtmHoldDestination marca um destino a ser colocado no estado de retenção por um determinado período de tempo. Uma retenção só ocorrerá se a última rota para o destino em qualquer exibição for excluída.
Os protocolos de roteamento que usam estados suspensos continuam anunciando a última rota até que a retenção expire, mesmo que as rotas mais recentes cheguem enquanto isso. A rota é anunciada como uma rota excluída. No entanto, as rotas mais recentes são usadas pelos protocolos de roteamento para fins de encaminhamento. Novas rotas são anunciadas quando a retenção expira.
Sintaxe
DWORD RtmHoldDestination(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_DEST_HANDLE DestHandle,
[in] RTM_VIEW_SET TargetViews,
[in] ULONG HoldTime
);
Parâmetros
[in] RtmRegHandle
Identificador para o cliente obtido de uma chamada anterior para RtmRegisterEntity.
[in] DestHandle
Manipule para o destino a ser marcado como holding.
[in] TargetViews
Especifica as exibições nas quais manter o destino.
[in] HoldTime
Especifica quanto tempo, em milissegundos, para manter o destino.
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 tempo de retenção especificado era zero. |
|
O manipulador é inválido. |
Comentários
Todas as rotas em um estado de retenção são mantidas para todos os modos de exibição por um único tempo de retenção máximo, independentemente do HoldTime especificado.
Para obter o código de exemplo que usa essa função, consulte Usar o estado de Hold-Down de rota.
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 |