VioScrUnLock (FAPI): Difference between revisions
No edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
This call releases ownership of (unlocks) the physical display buffer. | This call releases ownership of (unlocks) the physical display buffer. | ||
| Line 12: | Line 8: | ||
==Return Code== | ==Return Code== | ||
;rc (USHORT) - return:Return code descriptions are: | |||
Return code descriptions are: | *0 NO_ERROR | ||
* 0 | *367 ERROR_VIO_UNLOCK | ||
* 367 | *430 ERROR_VIO_ILLEGAL_DURING_POPUP | ||
* 430 | *436 ERROR_VIO_INVALID_HANDLE | ||
* 436 | *465 ERROR_VIO_DETACHED | ||
* 465 | *494 ERROR_VIO_EXTENDED_SG | ||
* 494 | |||
==Remarks== | ==Remarks== | ||
| Line 27: | Line 22: | ||
Some options operate differently in the DOS mode than in the OS/2 mode. Therefore, the following restriction applies to VioScrUnLock when coding in the DOS mode: | Some options operate differently in the DOS mode than in the OS/2 mode. Therefore, the following restriction applies to VioScrUnLock when coding in the DOS mode: | ||
The status always indicates the unlock is successful (return code = 0). | The status always indicates the unlock is successful (return code = 0). | ||
== | ==Bindings== | ||
=== C | ===C=== | ||
<PRE> | <PRE> | ||
#define INCL_VIO | #define INCL_VIO | ||
| Line 36: | Line 31: | ||
USHORT rc = VioScrUnLock(VioHandle); | USHORT rc = VioScrUnLock(VioHandle); | ||
HVIO | HVIO VioHandle; /* Video handle */ | ||
USHORT | USHORT rc; /* return code */ | ||
</PRE> | </PRE> | ||
===MASM | ===MASM=== | ||
<PRE> | <PRE> | ||
EXTRN VioScrUnLock:FAR | EXTRN VioScrUnLock:FAR | ||
Latest revision as of 13:23, 29 February 2020
This call releases ownership of (unlocks) the physical display buffer.
Syntax
VioScrUnLock (VioHandle)
Parameters
- VioHandle (HVIO) - input
- Reserved word of 0s.
Return Code
- rc (USHORT) - return
- Return code descriptions are:
- 0 NO_ERROR
- 367 ERROR_VIO_UNLOCK
- 430 ERROR_VIO_ILLEGAL_DURING_POPUP
- 436 ERROR_VIO_INVALID_HANDLE
- 465 ERROR_VIO_DETACHED
- 494 ERROR_VIO_EXTENDED_SG
Remarks
This call releases the screen lock that is set by VioScrLock. The VioScrUnLock call must be issued by a thread in the same process as the thread that issued VioScrLock.
Family API Considerations
Some options operate differently in the DOS mode than in the OS/2 mode. Therefore, the following restriction applies to VioScrUnLock when coding in the DOS mode:
The status always indicates the unlock is successful (return code = 0).
Bindings
C
#define INCL_VIO USHORT rc = VioScrUnLock(VioHandle); HVIO VioHandle; /* Video handle */ USHORT rc; /* return code */
MASM
EXTRN VioScrUnLock:FAR INCL_VIO EQU 1 PUSH WORD VioHandle ;Video handle CALL VioScrUnLock Returns WORD