Edit

PGET_EVENT_MESSAGE callback function (routprot.h)

  • Article

The GetEventMessage function gets an entry from the routing protocol's message queue. The routing protocol uses the queue to inform the router manager of asynchronous events.

Syntax

PGET_EVENT_MESSAGE PgetEventMessage;

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

Parameters

[out] Event

Pointer to an event. Information about this event is reported in the associated message. Note that this is not an event object. (The ROUTING_PROTOCOL_EVENTS type is declared in Routprot.h.)

This parameter receives one of the following values:

Value Meaning
ROUTER_STOPPED
 The router protocol shut down successfully. The message is empty for this event. (See StopProtocol)
SAVE_GLOBAL_CONFIG_INFO
 The routing protocol reports that its global configuration information has been changed by an external agent, that is, through means other than SetGlobalInfo. The routing protocol requests that the router manager retrieve and permanently store this information. The message is empty for this event.
SAVE_INTERFACE_CONFIG_INFO
 The routing protocol reports that the configuration information associated with one of its interfaces has been changed by an external agent, that is, through means other than SetInterfaceInfo. The routing protocol requests that the router manager retrieve and permanently store this information. The message contains the ID of the interface.
UPDATE_COMPLETE
 The routing protocol has completed an autostatic update request from the router manager. The router manager converts received routing information to static. The message contains the index of the interface on which the update was performed, the type of the information received (routes or services), and the result field, which indicates whether the update succeeded. See DoUpdateRoutes and DoUpdateServices.

[out] Result

Pointer to a MESSAGE union. The contents of the message are specific to the reported event.

This parameter is optional; the caller may specify NULL for this parameter.

Return value

If the entry is retrieved successfully, the return value is NO_ERROR.

If the routing protocol's message queue does not contain any entries, the return value is ERROR_NO_MORE_ITEMS.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header routprot.h

See also

DoUpdateRoutes

DoUpdateServices

MESSAGE

Routing Protocol Interface Functions

Routing Protocol Interface Reference

SetGlobalInfo

SetInterfaceInfo

StopProtocol