Função RtmLockDestination (rtmv2.h)

A função RtmLockDestination bloqueia ou desbloqueia um destino na tabela de roteamento. Use essa função para proteger um destino ao alterar ponteiros opacos.

Sintaxe

DWORD RtmLockDestination(
  [in] RTM_ENTITY_HANDLE RtmRegHandle,
  [in] RTM_DEST_HANDLE   DestHandle,
  [in] BOOL              Exclusive,
  [in] BOOL              LockDest
);

Parâmetros

[in] RtmRegHandle

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

[in] DestHandle

Manipule para o destino a ser bloqueado.

[in] Exclusive

Especifica se o destino deve ser bloqueado ou desbloqueado em um modo exclusivo (TRUE) ou compartilhado (FALSE).

[in] LockDest

Especifica se o destino deve ser bloqueado ou desbloqueado. Especifique TRUE para bloquear o destino; especifique FALSE para desbloqueá-lo.

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 esse destino.
ERROR_INVALID_HANDLE	O manipulador é inválido.

 

 

Comentários

Essa função também bloqueia as rotas associadas. Evite bloquear destinos por longos períodos de tempo, pois nenhum outro cliente pode acessar o destino e as rotas associadas até que o bloqueio seja liberado.

Um cliente também pode usar essa função ao ler informações para um destino, impedindo alterações durante a operação de leitura do cliente. Nesse caso, considere usar RtmGetDestInfo .

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

RtmGetOpaqueInformationPointer