VioModeUndo: Difference between revisions
m Ak120 moved page OS2 API:CPI:VioModeUndo to VioModeUndo |
mNo edit summary |
||
| Line 1: | Line 1: | ||
Allows one thread within a process to cancel a VioModeWait issued by another thread within the same process. | Allows one thread within a process to cancel a VioModeWait issued by another thread within the same process. | ||
==Syntax== | ==Syntax== | ||
<PRE> | <PRE> | ||
| Line 13: | Line 13: | ||
rc = VioModeUndo(OwnerIndic, KillIndic, Reserved); | rc = VioModeUndo(OwnerIndic, KillIndic, Reserved); | ||
</PRE> | </PRE> | ||
==Parameters== | ==Parameters== | ||
; | ;OwnerIndic (ULONG) - input : Ownership indicator. | ||
Indicates whether the thread issuing VioModeUndo wants ownership of VioModeWait to be reserved for its process. | Indicates whether the thread issuing VioModeUndo wants ownership of VioModeWait to be reserved for its process. | ||
Value Definition | Value Definition | ||
0 Reserve ownership | 0 Reserve ownership | ||
1 Give up ownership. | 1 Give up ownership. | ||
; KillIndic (ULONG) - input : Terminate indicator | ; KillIndic (ULONG) - input : Terminate indicator | ||
Indicates whether the thread (with the outstanding VioModeWait) should return an error code or be terminated. | Indicates whether the thread (with the outstanding VioModeWait) should return an error code or be terminated. | ||
Value Definition | Value Definition | ||
0 Return error code. | 0 Return error code. | ||
1 Terminate thread. | 1 Terminate thread. | ||
; Reserved (ULONG) - input : Reserved. Must be 0. | |||
==Return Code== | ==Return Code== | ||
rc (APIRET) - returns | rc (APIRET) - returns | ||
VioModeUndo returns one of the following values: | VioModeUndo returns one of the following values: | ||
| Line 41: | Line 38: | ||
* 486 ERROR_VIO_BAD_RESERVE | * 486 ERROR_VIO_BAD_RESERVE | ||
==Remarks== | ==Remarks== | ||
VioModeUndo can be issued only by a thread within the process that owns VioModeWait. The thread issuing VioModeUndo can either reserve ownership of the VioModeWait call for its process or give up ownership. The thread whose VioModeWait is canceled is optionally terminated. | VioModeUndo can be issued only by a thread within the process that owns VioModeWait. The thread issuing VioModeUndo can either reserve ownership of the VioModeWait call for its process or give up ownership. The thread whose VioModeWait is canceled is optionally terminated. | ||
[[Category: | [[Category:Vio]] | ||
Revision as of 10:50, 11 January 2017
Allows one thread within a process to cancel a VioModeWait issued by another thread within the same process.
Syntax
#define INCL_VIO #include <os2.h> ULONG OwnerIndic; /* Ownership indicator. */ ULONG KillIndic; /* Terminate indicator */ ULONG Reserved; /* Reserved. Must be 0. */ APIRET rc; /* Return code. */ rc = VioModeUndo(OwnerIndic, KillIndic, Reserved);
Parameters
- OwnerIndic (ULONG) - input
- Ownership indicator.
Indicates whether the thread issuing VioModeUndo wants ownership of VioModeWait to be reserved for its process.
Value Definition 0 Reserve ownership 1 Give up ownership.
- KillIndic (ULONG) - input
- Terminate indicator
Indicates whether the thread (with the outstanding VioModeWait) should return an error code or be terminated.
Value Definition 0 Return error code. 1 Terminate thread.
- Reserved (ULONG) - input
- Reserved. Must be 0.
Return Code
rc (APIRET) - returns
VioModeUndo returns one of the following values:
- 0 NO_ERROR
- 421 ERROR_VIO_INVALID_PARMS
- 422 ERROR_VIO_FUNCTION_OWNED
- 427 ERROR_VIO_NO_MODE_THREAD
- 430 ERROR_VIO_ILLEGAL_DURING_POPUP
- 486 ERROR_VIO_BAD_RESERVE
Remarks
VioModeUndo can be issued only by a thread within the process that owns VioModeWait. The thread issuing VioModeUndo can either reserve ownership of the VioModeWait call for its process or give up ownership. The thread whose VioModeWait is canceled is optionally terminated.