Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
en:docs:fapi:vioreadcellstr [2018/09/01 03:32] – created prokushev | en:docs:fapi:vioreadcellstr [2021/09/19 02:21] (current) – prokushev | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | {{page> | ||
+ | |||
+ | ====== VioReadCellStr ====== | ||
This call reads a string of character-attribute pairs (cells) from the screen, starting at the specified location. | This call reads a string of character-attribute pairs (cells) from the screen, starting at the specified location. | ||
- | ==Syntax== | + | ===== Syntax |
- | | + | <code c> |
+ | VioReadCellStr (CellStr, Length, Row, Column, VioHandle) | ||
+ | </ | ||
+ | ===== Parameters ===== | ||
- | ==Parameters== | + | * CellStr ([[PCH]]) - output : Address of the buffer where the cell string is returned. |
- | ;CellStr (PCH) - output : Address of the buffer where the cell string is returned. | + | |
- | ;Length (PUSHORT) - input/ | + | |
- | ;Row (USHORT) - input : Starting row of the field to read, 0 is the top row. | + | |
- | ;Column (USHORT) - input : Starting column of the field to read, 0 is the leftmost column. | + | |
- | ;VioHandle (HVIO) - input : This must be zero unless the caller is a Presentation Manager application, | + | |
+ | ===== Return Code ===== | ||
+ | |||
+ | ===== Remarks ===== | ||
- | ==Return Code== | ||
If a string read comes to the end of the line and is not complete, the string read continues at the beginning of the next line. If the read comes to the end of the screen and is not complete, the read terminates and the length is set to the length of the buffer that was filled. | If a string read comes to the end of the line and is not complete, the string read continues at the beginning of the next line. If the read comes to the end of the screen and is not complete, the read terminates and the length is set to the length of the buffer that was filled. | ||
- | ===PM Considerations=== | + | ====PM Considerations==== |
VioReadCellStr reads a string of character/ | VioReadCellStr reads a string of character/ | ||
- | ==Example Code== | + | ===== Bindings ===== |
- | === C Binding=== | + | |
- | <PRE> | + | ==== C Binding==== |
+ | <code c> | ||
#define INCL_VIO | #define INCL_VIO | ||
Line 32: | Line 41: | ||
USHORT | USHORT | ||
- | </PRE> | + | </code> |
- | ===MASM Binding=== | + | ====MASM Binding==== |
- | <PRE> | + | <code asm> |
EXTRN VioReadCellStr: | EXTRN VioReadCellStr: | ||
INCL_VIO | INCL_VIO | ||
Line 47: | Line 56: | ||
Returns WORD | Returns WORD | ||
- | </PRE> | + | </code> |
- | ====== Note ====== | + | ===== Note ===== |
Text based on [[http:// | Text based on [[http:// |