PGET_EVENT_MESSAGE função de retorno de chamada (routprot.h)

Artigo
03/01/2024

A função GetEventMessage obtém uma entrada da fila de mensagens do protocolo de roteamento. O protocolo de roteamento usa a fila para informar o gerenciador de roteador sobre eventos assíncronos.

Sintaxe

PGET_EVENT_MESSAGE PgetEventMessage;

DWORD PgetEventMessage(
  [out] ROUTING_PROTOCOL_EVENTS *Event,
  [out] MESSAGE *Result
)
{...}

Parâmetros

[out] Event

Ponteiro para um evento. Informações sobre esse evento são relatadas na mensagem associada. Observe que este não é um objeto de evento. (O tipo ROUTING_PROTOCOL_EVENTS é declarado em Routprot.h.)

Esse parâmetro recebe um dos seguintes valores:

Valor	Significado
ROUTER_STOPPED	O protocolo do roteador foi desligado com êxito. A mensagem está vazia para esse evento. (Consulte StopProtocol)
SAVE_GLOBAL_CONFIG_INFO	O protocolo de roteamento informa que suas informações de configuração global foram alteradas por um agente externo, ou seja, por meio de meios diferentes de SetGlobalInfo. O protocolo de roteamento solicita que o gerenciador de roteador recupere e armazene permanentemente essas informações. A mensagem está vazia para esse evento.
SAVE_INTERFACE_CONFIG_INFO	O protocolo de roteamento informa que as informações de configuração associadas a uma de suas interfaces foram alteradas por um agente externo, ou seja, por meio de meios diferentes de SetInterfaceInfo. O protocolo de roteamento solicita que o gerenciador de roteador recupere e armazene permanentemente essas informações. A mensagem contém a ID da interface .
UPDATE_COMPLETE	O protocolo de roteamento concluiu uma solicitação de atualização automática do gerenciador de roteadores. O gerenciador de roteador converte as informações de roteamento recebidas em estáticas. A mensagem contém o índice da interface na qual a atualização foi executada, o tipo das informações recebidas (rotas ou serviços) e o campo de resultado, que indica se a atualização foi bem-sucedida. Consulte DoUpdateRoutes e DoUpdateServices.

[out] Result

Ponteiro para uma união MESSAGE . O conteúdo da mensagem é específico para o evento relatado.

Esse parâmetro é opcional; o chamador pode especificar NULL para esse parâmetro.

Retornar valor

Se a entrada for recuperada com êxito, o valor retornado será NO_ERROR.

Se a fila de mensagens do protocolo de roteamento não contiver entradas, o valor retornado será ERROR_NO_MORE_ITEMS.

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	routprot.h