Purpose

For clients on Windows systems only. Enter an event loop and process all outstanding SPD events. Once all events have been processed, this function returns to the caller.

Use of this function allows you to merge the SPD event loop with a Windows event loop. You should use it instead of SPD_MainLoop for a client that runs on a Windows system. For example, the Windows event loop can be periodically interrupted via a timer event. The handler for the timer event can call SPD_ProcessEvents to process all outstanding SPD events before returning to the Windows event loop. This is illustrated in 2.2.

Syntax

#include "spd.h"

SPD_errorTP SPD_ProcessEvents(void);

Return Value

A return value of SPD_notInitializedCN indicates that the SPD_InitClient client function was not previously called.

See Also

Contrast with the corresponding client function SPD_MainLoop for UNIX systems ([xref text to replace]).

Use of this function is illustrated in 2.2.