Jump to content

VioScrUnLock (FAPI): Difference between revisions

From EDM2
Ak120 (talk | contribs)
Ak120 (talk | contribs)
mNo edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Description==
This call releases ownership of (unlocks) the physical display buffer.
This call releases ownership of (unlocks) the physical display buffer.


==Syntax==
==Syntax==
<PRE>
  VioScrUnLock (VioHandle)
  VioScrUnLock
 
    (VioHandle)
</PRE>


==Parameters==
==Parameters==
; VioHandle (HVIO) - input : Reserved word of 0s.
;VioHandle (HVIO) - input : Reserved word of 0s.


==Return Code==
==Return Code==
rc (USHORT) - return
;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


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==
==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.
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===
===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:
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).


==Example Code==
==Bindings==
=== C Binding===
===C===
<PRE>
<PRE>
#define INCL_VIO
#define INCL_VIO
Line 39: Line 31:
USHORT  rc = VioScrUnLock(VioHandle);
USHORT  rc = VioScrUnLock(VioHandle);


HVIO             VioHandle;    /* Video handle */
HVIO   VioHandle;    /* Video handle */


USHORT           rc;            /* return code */
USHORT rc;            /* return code */
</PRE>
</PRE>


===MASM Binding===
===MASM===
<PRE>
<PRE>
EXTRN  VioScrUnLock:FAR
EXTRN  VioScrUnLock:FAR
Line 56: Line 48:


==Related Functions==
==Related Functions==
*  
* [[VioScrLock (FAPI)|VioScrLock]]


[[Category:The OS/2 API Project]]
[[Category:Vio]]

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

Related Functions