Game Accessibility Library logo SourceForge.net Logo
Game Accessibility Suite: CATSignal::Wait
CATResult CATSignal::Wait ( CATUInt32  milliseconds = 0xFFFFFFFF  ) 

Wait() waits up to [milliseconds] milliseconds for the signal to be fired. If the CATSignal is set to auto-reset, the it will be reset when a caller successfully receive the event through a wait.

Check the result code here! It can very easily time out.

The default, however, is an infinite wait.

Parameters:
milliseconds - milliseconds to wait while trying to get synch
See also:
Release()

Definition at line 47 of file CATSignal_Win32.cpp.

References CAT_ERR_SIGNAL_INVALID_HANDLE, CAT_ERR_SIGNAL_TIMEOUT, CAT_ERR_SIGNAL_WAIT_ERROR, CAT_SUCCESS, CATRESULT, and fEvent.

Referenced by CATWaitDlg::StartWait(), and CATWindow::ThreadedCmdThread().


Generated on Mon Feb 11 04:10:51 2008 for Game Accessibility Suite by doxygen 1.5.4