VioSavRedrawUndo: Difference between revisions
m Ak120 moved page OS2 API:CPI:VioSavRedrawUndo to VioSavRedrawUndo |
mNo edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
Allows one thread within a process to cancel a [[VioSavRedrawWait]] issued by another thread within the same process. | |||
Allows one thread within a process to cancel a VioSavRedrawWait issued by another thread within the same process. | |||
==Syntax== | ==Syntax== | ||
VioSavRedrawUndo(OwnerIndic, KillIndic, VioHandle) | |||
==Parameters== | ==Parameters== | ||
; OwnerIndic (ULONG) - input : Ownership indicator | ;OwnerIndic (ULONG) - input: Ownership indicator | ||
Indicates whether the thread issuing VioSavRedrawUndo wants ownership of VioSavRedrawUndo to be reserved for its process. | :Indicates whether the thread issuing VioSavRedrawUndo wants ownership of VioSavRedrawUndo to be reserved for its process. | ||
::0 Reserve ownership. | |||
::1 Give up ownership. | |||
;KillIndic (ULONG) - input : Terminate indicator | |||
; KillIndic (ULONG) - input : Terminate indicator | |||
Indicates whether the thread (with the outstanding VioSavRedrawUndo) should return an error code or be terminated. | Indicates whether the thread (with the outstanding VioSavRedrawUndo) should return an error code or be terminated. | ||
::0 Return error code. | |||
::1 Terminate thread. | |||
;VioHandle (HVIO) - input: Reserved. Must be 0. | |||
==Return Code== | ==Return Code== | ||
rc (APIRET) - returns | rc (APIRET) - returns | ||
VioSavRedrawUndo returns one of the following values: | VioSavRedrawUndo returns one of the following values: | ||
* 0 NO_ERROR | |||
* 0 | *421 ERROR_VIO_INVALID_PARMS | ||
* 421 | *422 ERROR_VIO_FUNCTION_OWNED | ||
* 422 | *428 ERROR_VIO_NO_SAVE_RESTORE_THD | ||
* 428 | *430 ERROR_VIO_ILLEGAL_DURING_POPUP | ||
* 430 | |||
==Remarks== | ==Remarks== | ||
The issuing thread can reserve ownership of VioSavRedrawWait for its process or give it up. The thread whose VioSavRedrawWait was canceled is optionally terminated. VioSavRedrawUndo can be issued only by a thread within the same process that owns VioSavRedrawWait. | The issuing thread can reserve ownership of [[VioSavRedrawWait]] for its process or give it up. The thread whose VioSavRedrawWait was canceled is optionally terminated. VioSavRedrawUndo can be issued only by a thread within the same process that owns VioSavRedrawWait. | ||
[[Category: | [[Category:Vio]] | ||
Latest revision as of 00:39, 9 November 2022
Allows one thread within a process to cancel a VioSavRedrawWait issued by another thread within the same process.
Syntax
VioSavRedrawUndo(OwnerIndic, KillIndic, VioHandle)
Parameters
- OwnerIndic (ULONG) - input
- Ownership indicator
- Indicates whether the thread issuing VioSavRedrawUndo wants ownership of VioSavRedrawUndo to be reserved for its process.
- 0 Reserve ownership.
- 1 Give up ownership.
- KillIndic (ULONG) - input
- Terminate indicator
Indicates whether the thread (with the outstanding VioSavRedrawUndo) should return an error code or be terminated.
- 0 Return error code.
- 1 Terminate thread.
- VioHandle (HVIO) - input
- Reserved. Must be 0.
Return Code
rc (APIRET) - returns
VioSavRedrawUndo returns one of the following values:
- 0 NO_ERROR
- 421 ERROR_VIO_INVALID_PARMS
- 422 ERROR_VIO_FUNCTION_OWNED
- 428 ERROR_VIO_NO_SAVE_RESTORE_THD
- 430 ERROR_VIO_ILLEGAL_DURING_POPUP
Remarks
The issuing thread can reserve ownership of VioSavRedrawWait for its process or give it up. The thread whose VioSavRedrawWait was canceled is optionally terminated. VioSavRedrawUndo can be issued only by a thread within the same process that owns VioSavRedrawWait.