VioScrUnLock (FAPI): Difference between revisions
No edit summary |
|||
| Line 1: | Line 1: | ||
{{Legacy | |||
|RepFunc=[[VioScrUnLock]] | |||
|Remarks=This page list the older version of the function for reference. | |||
}} | |||
This call releases ownership of (unlocks) the physical display buffer. | This call releases ownership of (unlocks) the physical display buffer. | ||
Revision as of 23:28, 16 September 2017
 Legacy Function Warning
| |
|---|---|
| It is recommended to use a newer replacement for this function. | |
| Replacement: | VioScrUnLock |
| Remarks: | This page list the older version of the function for reference. |
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).
Example Code
C Binding
#define INCL_VIO USHORT rc = VioScrUnLock(VioHandle); HVIO VioHandle; /* Video handle */ USHORT rc; /* return code */
MASM Binding
EXTRN VioScrUnLock:FAR INCL_VIO EQU 1 PUSH WORD VioHandle ;Video handle CALL VioScrUnLock Returns WORD