en:docs:fapi:vioscrolldn

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
en:docs:fapi:vioscrolldn [2021/08/20 08:09] – prokusheven:docs:fapi:vioscrolldn [2021/09/19 02:37] (current) – prokushev
Line 1: Line 1:
 {{page>en:templates:fapiint}} {{page>en:templates:fapiint}}
 +
 +====== VioScrollDn ======
  
 This call scrolls the entire display buffer (or area specified within the display buffer) down. This call scrolls the entire display buffer (or area specified within the display buffer) down.
  
-==Syntax== +===== Syntax ===== 
- VioScrollDn (TopRow, LeftCol, BotRow, RightCol, Lines, Cell, VioHandle)+<code c> 
 +VioScrollDn (TopRow, LeftCol, BotRow, RightCol, Lines, Cell, VioHandle) 
 +</code>
  
-==Parameters== +===== Parameters ===== 
-;TopRow (USHORT) - input : Top row to be scrolled.  + 
-;LeftCol (USHORT) - input : Left column to be scrolled.  +  * TopRow ([[USHORT]]) - input : Top row to be scrolled.  
-;BotRow (USHORT) - input : Bottom row to be scrolled.  +  * LeftCol ([[USHORT]]) - input : Left column to be scrolled.  
-;RightCol (USHORT) - input : Right column to be scrolled.  +  * BotRow ([[USHORT]]) - input : Bottom row to be scrolled.  
-;Lines (USHORT) - input : Number of lines to be inserted at the top of the screen area being scrolled. If 0 is specified, no lines are scrolled. +  * RightCol ([[USHORT]]) - input : Right column to be scrolled.  
-;Cell (PBYTE) - input : Address of the character-attribute(s) pair (2 or 4 bytes) used as a fill character on inserted lines. +  * Lines ([[USHORT]]) - input : Number of lines to be inserted at the top of the screen area being scrolled. If 0 is specified, no lines are scrolled. 
-;VioHandle (HVIO) - input : This must be zero unless the caller is a Presentation Manager application, in which case it must be the value returned by VioGetPs.+  * Cell ([[PBYTE]]) - input : Address of the character-attribute(s) pair (2 or 4 bytes) used as a fill character on inserted lines. 
 +  * VioHandle ([[HVIO]]) - input : This must be zero unless the caller is a Presentation Manager application, in which case it must be the value returned by VioGetPs. 
 + 
 +===== Return Code ===== 
 + 
 +rc ([[USHORT]]) - return
  
-==Return Code== 
- rc (USHORT) - return 
 Return code descriptions are: Return code descriptions are:
-* 0          NO_ERROR  
-* 355        ERROR_VIO_MODE  
-* 358        ERROR_VIO_ROW  
-* 359        ERROR_VIO_COL  
-* 436        ERROR_VIO_INVALID_HANDLE  
-* 465        ERROR_VIO_DETACHED 
  
-==Remarks==+  * 0          NO_ERROR  
 +  * 355        ERROR_VIO_MODE  
 +  * 358        ERROR_VIO_ROW  
 +  * 359        ERROR_VIO_COL  
 +  * 436        ERROR_VIO_INVALID_HANDLE  
 +  * 465        ERROR_VIO_DETACHED 
 + 
 +===== Remarks ===== 
 TopRow = 0 and LeftCol = 0 identifies the top left corner of the screen. TopRow = 0 and LeftCol = 0 identifies the top left corner of the screen.
  
Line 33: Line 42:
  
  
-===OS/2 Toolkit 4.52=== +===== Bindings =====
-This function is defined on bsesub.h header of the OS/2 Toolkit on 4.52. +
-    #define VioScrollDn             VIO16SCROLLDN +
- +
-   APIRET16 APIENTRY16  VioScrollDn (USHORT usTopRow, +
-                                     USHORT usLeftCol, +
-                                     USHORT usBotRow, +
-                                     USHORT usRightCol, +
-                                     USHORT cbLines, +
-                                     PBYTE pCell, +
-                                     HVIO hvio);+
  
-==Example Code== 
  
-===C Binding=== +====C Binding==== 
-<PRE>+<code c>
 #define INCL_VIO #define INCL_VIO
  
Line 63: Line 61:
  
 USHORT           rc;            /* return code */ USHORT           rc;            /* return code */
-</PRE> +</code> 
-===MASM Binding=== +====MASM Binding==== 
-<PRE>+<code asm>
 EXTRN  VioScrollDn:FAR EXTRN  VioScrollDn:FAR
 INCL_VIO            EQU 1 INCL_VIO            EQU 1
Line 79: Line 77:
  
 Returns WORD Returns WORD
-</PRE>+</code>
  
  
  
-====== Note ======+===== Note =====
  
 Text based on [[http://www.edm2.com/index.php/VioScrollDn]] Text based on [[http://www.edm2.com/index.php/VioScrollDn]]