GpiSuspendPlay
This is an undocumented function.
GpiSuspendPlay appears to be a control function that pauses or interrupts this playback process. It is used internally by the system for:
- Interrupt handling: Pausing graphics output when the system needs to prioritize other tasks.
- Synchronizing: Managing the flow of graphics commands when a complex segment or a large metafile is being drawn, ensuring that the system can properly handle window updates or hardware context switches.
Syntax
rc = GpiSuspendPlay( hps)
Parameters
- hps (HPS) - input
- The handle to the presentation space where the segment or metafile is being played.
Returns
- rc (BOOL) - returns
- Success indicator.
- TRUE, if the playback was successfully suspended.
- Successful completion
- FALSE
- Error occurred. If the function failed (e.g., if there was no active playback to suspend).