Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revision | |||
| en:docs:fapi:vioscrollrt [2021/08/20 08:22] – prokushev | en:docs:fapi:vioscrollrt [2021/09/19 02:54] (current) – prokushev | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| {{page> | {{page> | ||
| + | ====== VioScrollRt ====== | ||
| + | |||
| This call scrolls the entire display buffer (or area specified within the display buffer) to the right. | This call scrolls the entire display buffer (or area specified within the display buffer) to the right. | ||
| - | ==Syntax== | + | ===== Syntax ===== |
| - | | + | <code c> |
| + | VioScrollRt (TopRow, LeftCol, BotRow, RightCol, Lines, Cell, VioHandle) | ||
| + | </ | ||
| + | |||
| + | ===== 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 columns to be inserted at the left 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 columns. | ||
| + | * VioHandle ([[HVIO]]) - input : This must be zero unless the caller is a Presentation Manager application, | ||
| + | |||
| + | ===== Return Code ===== | ||
| - | ==Parameters== | + | rc ([[USHORT]]) - return |
| - | ; | + | |
| - | ;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 columns to be inserted at the left 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 columns. | + | |
| - | ; VioHandle (HVIO) - input : This must be zero unless the caller is a Presentation Manager application, | + | |
| - | ==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 31: | Line 39: | ||
| 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. | ||
| - | ==Example Code== | + | ===== Bindings ===== |
| - | === C Binding=== | + | |
| - | <PRE> | + | ==== C Binding==== |
| + | <code c> | ||
| #define INCL_VIO | #define INCL_VIO | ||
| Line 47: | Line 56: | ||
| USHORT | USHORT | ||
| - | </PRE> | + | </code> |
| - | === MASM Binding=== | + | ==== MASM Binding==== |
| - | <PRE> | + | <code asm> |
| EXTRN VioScrollRt: | EXTRN VioScrollRt: | ||
| INCL_VIO | INCL_VIO | ||
| Line 64: | Line 73: | ||
| Returns WORD | Returns WORD | ||
| - | </PRE> | + | </code> |
| - | + | ||
| - | ====== Note ====== | + | ===== Note ===== |
| Text based on [[http:// | Text based on [[http:// | ||