en:docs:fapi:vioscrunlock

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
en:docs:fapi:vioscrunlock [2018/09/01 09:53] – created prokusheven:docs:fapi:vioscrunlock [2021/09/19 04:04] (current) prokushev
Line 1: Line 1:
 +{{page>en:templates:fapiint}}
 +
 +====== VioScrUnLock ======
  
 This call releases ownership of (unlocks) the physical display buffer. This call releases ownership of (unlocks) the physical display buffer.
  
-==Syntax== +===== Syntax ===== 
- VioScrUnLock (VioHandle)+<code c> 
 +VioScrUnLock (VioHandle) 
 +</code> 
 +===== Parameters =====
  
-==Parameters== +  * VioHandle ([[HVIO]]) - input : Reserved word of 0s. 
-;VioHandle (HVIO) - input : Reserved word of 0s.+ 
 +===== Return Code ===== 
 + 
 +rc ([[USHORT]]) - return
  
-==Return Code== 
- rc (USHORT) - return 
 Return code descriptions are: 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==+  * 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. 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=== + 
-<PRE>+==== C Binding==== 
 +<code c>
 #define INCL_VIO #define INCL_VIO
  
Line 36: Line 47:
  
 USHORT           rc;            /* return code */ USHORT           rc;            /* return code */
-</PRE>+</code>
  
-===MASM Binding=== +====MASM Binding==== 
-<PRE>+<code asm>
 EXTRN  VioScrUnLock:FAR EXTRN  VioScrUnLock:FAR
 INCL_VIO            EQU 1 INCL_VIO            EQU 1
Line 47: Line 58:
  
 Returns WORD Returns WORD
-</PRE> +</code>
- +
  
-====== Note ======+===== Note =====
  
 Text based on [[http://www.edm2.com/index.php/VioScrUnLock_(FAPI)]] Text based on [[http://www.edm2.com/index.php/VioScrUnLock_(FAPI)]]