Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
| en:docs:fapi:vioscrollup [2021/08/20 09:03] – created prokushev | en:docs:fapi:vioscrollup [2021/09/19 05:29] (current) – prokushev | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| {{page> | {{page> | ||
| + | ====== 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 ===== |
| - | | + | <code c> |
| + | VioScrollUp (TopRow, LeftCol, BotRow, RightCol, Lines, Cell, VioHandle) | ||
| + | </ | ||
| - | ==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, | + | |
| - | ==Return Code== | ||
| - | ;rc (USHORT) - return: | ||
| - | *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 ([[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, | ||
| + | |||
| + | ===== 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 ===== | ||
| 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 31: | 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 48: | Line 59: | ||
| USHORT | USHORT | ||
| - | </PRE> | + | </code> |
| - | ===MASM=== | + | ====MASM==== |
| - | <PRE> | + | <code asm> |
| EXTRN VioScrollUp: | EXTRN VioScrollUp: | ||
| INCL_VIO | INCL_VIO | ||
| Line 65: | Line 76: | ||
| Returns WORD | Returns WORD | ||
| - | </PRE> | + | </code> |
| + | |||
| + | ===== Related Functions ===== | ||
| - | ==Related Functions== | ||
| *[[VioScrollDn]] | *[[VioScrollDn]] | ||