GetEventMessage

[This is preliminary documentation and subject to change.]

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.

DWORD GetEventMessage(
  ROUTING_PROTOCOL_EVENTS  * Event,
                       // address of message queue entry
  MESSAGE  * Result    // event dependent message
);
 

Parameters

Event

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

Event values

Value	Description
ROUTER_STOPPED	The router protocol shutdown 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 SetInterfaceConfigInfo. 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 can proceed with converting 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.

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 Values

NO_ERROR

The entry was retrieved successfully.

ERROR_NO_MORE_ITEMS

The routing protocol's message queue does not contain any entries.

QuickInfo

  Windows NT: Use version 5.0 and later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in routprot.h.
  Import Library: user-defined.

See Also

DoUpdateRoutes, DoUpdateServices, GetEventMessage Sample, MESSAGE, SetGlobalInfo, SetInterfaceConfigInfo, StopProtocol