VioScrollUp (FAPI): Difference between revisions
Created page with "==Description== This call scrolls the entire display buffer (or area specified within the display buffer) up. ==Syntax== <PRE> VioScrollUp (TopRow, LeftCol, BotRow, Rig..." |
mNo edit summary |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
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) | |||
VioScrollUp | |||
==Parameters== | ==Parameters== | ||
; TopRow (USHORT) - input : Top row to be scrolled. | ;TopRow (USHORT) - input: Top row to be scrolled. | ||
;LeftCol (USHORT) - input: Left column 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. | |||
; BotRow (USHORT) - input : Bottom row 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. | |||
; RightCol (USHORT) - input : Right column to be 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. | ||
; 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== | ==Return Code== | ||
;rc (USHORT) - return:Return code descriptions are: | |||
*0 NO_ERROR | |||
Return code descriptions are: | *355 ERROR_VIO_MODE | ||
*358 ERROR_VIO_ROW | |||
* 0 | *359 ERROR_VIO_COL | ||
* 355 | *436 ERROR_VIO_INVALID_HANDLE | ||
* 358 | *465 ERROR_VIO_DETACHED | ||
* 359 | |||
* 436 | |||
* 465 | |||
==Remarks== | ==Remarks== | ||
| Line 40: | Line 27: | ||
If a value greater than the maximum value is specified for TopRow, LeftCol, BotRow, RightCol, or Lines, the maximum value for that parameter is used. | If a value greater than the maximum value is specified for TopRow, LeftCol, BotRow, RightCol, or Lines, the maximum value for that parameter is used. | ||
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== | ||
===C | ===C=== | ||
<PRE> | <PRE> | ||
#define INCL_VIO | #define INCL_VIO | ||
| Line 50: | Line 37: | ||
VioHandle); | VioHandle); | ||
USHORT | USHORT TopRow; /* Top row */ | ||
USHORT | USHORT LeftCol; /* Left column */ | ||
USHORT | USHORT BotRow; /* Bottom row */ | ||
USHORT | USHORT RightCol; /* Right column */ | ||
USHORT | USHORT Lines; /* Number of lines */ | ||
PBYTE | PBYTE Cell; /* Fill character */ | ||
HVIO | HVIO VioHandle; /* Video handle */ | ||
USHORT | USHORT rc; /* return code */ | ||
</PRE> | </PRE> | ||
===MASM | ===MASM=== | ||
<PRE> | <PRE> | ||
EXTRN VioScrollUp:FAR | EXTRN VioScrollUp:FAR | ||
| Line 77: | Line 64: | ||
Returns WORD | Returns WORD | ||
</PRE> | </PRE> | ||
==Related Functions== | ==Related Functions== | ||
* | *[[VioScrollDn]] | ||
[[Category: | [[Category:Vio]] | ||
Latest revision as of 17:09, 28 February 2020
This call scrolls the entire display buffer (or area specified within the display buffer) up.
Syntax
VioScrollUp (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 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
- 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.
If a value greater than the maximum value is specified for TopRow, LeftCol, BotRow, RightCol, or Lines, the maximum value for that parameter is used.
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
C
#define INCL_VIO
USHORT rc = VioScrollUp(TopRow, LeftCol, BotRow, RightCol, Lines, Cell,
VioHandle);
USHORT TopRow; /* Top row */
USHORT LeftCol; /* Left column */
USHORT BotRow; /* Bottom row */
USHORT RightCol; /* Right column */
USHORT Lines; /* Number of lines */
PBYTE Cell; /* Fill character */
HVIO VioHandle; /* Video handle */
USHORT rc; /* return code */
MASM
EXTRN VioScrollUp:FAR INCL_VIO EQU 1 PUSH WORD TopRow ;Top row PUSH WORD LeftCol ;Left column PUSH WORD BotRow ;Bottom row PUSH WORD RightCol ;Right column PUSH WORD Lines ;Number of lines PUSH@ OTHER Cell ;Fill character PUSH WORD VioHandle ;Video handle CALL VioScrollUp Returns WORD