Compartilhar via


Função RtmRegisterForChangeNotification (rtmv2.h)

A função RtmRegisterForChangeNotification informa ao gerenciador de tabelas de roteamento que o cliente deve receber notificações de alteração para os tipos de alterações especificados. O gerenciador de tabelas de roteamento retorna um identificador de notificação de alteração, que o cliente deve usar ao solicitar informações de alteração após receber uma mensagem de notificação de alteração.

Sintaxe

DWORD RtmRegisterForChangeNotification(
  [in]  RTM_ENTITY_HANDLE  RtmRegHandle,
  [in]  RTM_VIEW_SET       TargetViews,
  [in]  RTM_NOTIFY_FLAGS   NotifyFlags,
  [in]  PVOID              NotifyContext,
  [out] PRTM_NOTIFY_HANDLE NotifyHandle
);

Parâmetros

[in] RtmRegHandle

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

[in] TargetViews

Especifica os modos de exibição nos quais registrar-se para notificação de alteração.

[in] NotifyFlags

Especifica os sinalizadores que indicam o tipo de alterações para as quais o cliente solicita notificação. Os sinalizadores a seguir são usados. (Os sinalizadores devem ser unidos usando um OR lógico.)

Constante Significado
RTM_CHANGE_TYPE_ALL
Notifique o cliente sobre qualquer alteração em um destino.
RTM_CHANGE_TYPE_BEST
Notifique o cliente sobre as alterações na melhor rota atual ou quando a melhor rota for alterada.
RTM_CHANGE_TYPE_FORWARDING
Notifique o cliente sobre as melhores alterações de rota que afetam o encaminhamento, como alterações no próximo salto.
RTM_NOTIFY_ONLY_MARKED_DESTS
Notifique o cliente sobre as alterações nos destinos que o cliente marcou. Se esse sinalizador não for especificado, as mensagens de notificação de alteração para todos os destinos serão enviadas.

[in] NotifyContext

Especifica o contexto de notificação que o RTM_EVENT_CALLBACK usa para indicar novas alterações. O contexto de notificação é o parâmetro Context2 do retorno de chamada RTM_EVENT_CALLBACK .

[out] NotifyHandle

Recebe um identificador para uma notificação de alteração. O identificador deve ser usado ao chamar RtmGetChangedDests.

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_INVALID_PARAMETER
Um parâmetro contém informações incorretas.
ERROR_NO_SYSTEM_RESOURCES
Não há recursos do sistema disponíveis suficientes para concluir essa operação. O gerenciador de tabelas de roteamento excedeu o número máximo de notificações de alteração que podem ser armazenadas em cache.
ERROR_NOT_ENOUGH_MEMORY
Não há memória suficiente para concluir essa operação.
ERROR_NOT_SUPPORTED
Não há suporte para uma ou mais das exibições especificadas.
 
 

Comentários

Um cliente chama RtmMarkDestForChangeNotification quando está se registrando para alterações em um destino específico.

O gerenciador de tabela de roteamento usa o retorno de chamada RTM_EVENT_CALLBACK , especificado quando o cliente chamado RtmRegisterEntity, para notificar o cliente quando ocorreram alterações; o cliente deve chamar RtmGetChangedDests para receber as informações de alteração reais.

Para obter o código de exemplo que usa essa função, consulte Registrar-se para notificação de alteração.

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

RtmDeregisterFromChangeNotification

RtmGetChangedDests

RtmMarkDestForChangeNotification