return-value-to-windows

Function

Package: common-graphics

Arguments: value

Sets up a value to be returned to the operating system when the code that is currently executing in response to some event completes. Usually win:false (0) is returned from event handlers, though sometimes the OS expects some other value to conditionally be returned. Common Graphics returns appropriate values internally, but if an application adds cg::window-procedure methods to handle raw events, and an event expects a particular non-zero return value, then return-value-to-windows should be called at some point during the handling of the event to set up the proper value. Note that return-value-to-windows does not actually cause a return when called, but merely establishes the value that will eventually be returned.

Common Graphics and IDE documentation is described in About Common Graphics and IDE documentation in cgide.htm.

The documentation is described in introduction.htm and the index is in index.htm.

Created 2000.10.5.