en:docs:fapi:vioscrollup

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
en:docs:fapi:vioscrollup [2021/08/30 10:38] prokusheven:docs:fapi:vioscrollup [2021/09/19 05:29] (current) prokushev
Line 1: Line 1:
 {{page>en:templates:fapiint}} {{page>en:templates:fapiint}}
 +====== VioScrollUp ====== 
 + 
 This call scrolls the entire display buffer (or area specified within the display buffer) up. This call scrolls the entire display buffer (or area specified within the display buffer) up.
  
-==Syntax== +===== Syntax ===== 
- VioScrollUp (TopRow, LeftCol, BotRow, RightCol, Lines, Cell, VioHandle)+<code c> 
 +VioScrollUp (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. 
-  * BotRow (USHORT) - input: Bottom row to be scrolled. 
-  * RightCol (USHORT) - input: Right column to be scrolled. 
-  * Lines (USHORT) - input: Number of lines to be inserted at the bottom of the screen area being scrolled. If 0 is specified, no lines are scrolled. 
-  * 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== +  * TopRow ([[USHORT]]) - input: Top row to be scrolled. 
-;rc (USHORT) - return:Return code descriptions are: +  * LeftCol ([[USHORT]]) - input: Left column to be scrolled. 
-*0 NO_ERROR +  * BotRow ([[USHORT]]) - input: Bottom row to be scrolled. 
-*355 ERROR_VIO_MODE +  * RightCol ([[USHORT]]) - input: Right column to be scrolled. 
-*358 ERROR_VIO_ROW +  * Lines ([[USHORT]]) - input: Number of lines to be inserted at the bottom of the screen area being scrolled. If 0 is specified, no lines are scrolled. 
-*359 ERROR_VIO_COL +  * Cell ([[PBYTE]]) - input: Address of the character attribute(s) pair (2 or 4 bytes) used as a fill character on inserted lines. 
-*436 ERROR_VIO_INVALID_HANDLE +  * 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. 
-*465 ERROR_VIO_DETACHED+ 
 +===== Return Code ===== 
 + 
 +rc ([[USHORT]]) - return 
 + 
 +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 =====
  
-==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 32: Line 41:
 If TopRow and LeftCol = 0 and if BotRow, RightCol, and Lines = 65535 (or -1 in assembler language), the entire screen is filled with the character-attribute pair defined by Cell. If TopRow and LeftCol = 0 and if BotRow, RightCol, and Lines = 65535 (or -1 in assembler language), the entire screen is filled with the character-attribute pair defined by Cell.
  
-==Bindings== +===== Bindings ===== 
-===C=== + 
-<PRE>+====C==== 
 +<code c>
 #define INCL_VIO #define INCL_VIO
  
Line 49: Line 59:
  
 USHORT  rc;            /* return code */ USHORT  rc;            /* return code */
-</PRE>+</code>
  
-===MASM=== +====MASM==== 
-<PRE>+<code asm>
 EXTRN  VioScrollUp:FAR EXTRN  VioScrollUp:FAR
 INCL_VIO            EQU 1 INCL_VIO            EQU 1
Line 66: Line 76:
  
 Returns WORD Returns WORD
-</PRE>+</code> 
 + 
 +===== Related Functions =====
  
-==Related Functions== 
 *[[VioScrollDn]]  *[[VioScrollDn]]