VioReadCharStr

From EDM2
Revision as of 19:19, 27 January 2017 by Ak120 (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Reads a string of characters from the display, starting at the specified location.

Syntax

rc = VioReadCharStr(CharStr, Length, Row, Column, VioHandle);

Parameters

CharStr (PCH) - output 
Character buffer.
Address of the buffer where the character string is returned.
Length (PULONG) - in/out 
Length of buffer.
Address of the buffer length in bytes.
Row (ULONG) - input 
Starting row location.
Starting row of the field to read, where 0 is the top row.
Column (ULONG) - input 
Starting column location.
Starting column of the field to read, where 0 is the leftmost column.
VioHandle (HVIO) - input 
Vio presentation-space handle.
This must be 0, unless the caller is a Presentation Manager application; in this case, it must be the value returned by VioCreatePS.

Return Code

rc (APIRET) - returns

VioReadCharStr returns one of the following values:

  • 0 NO_ERROR
  • 355 ERROR_VIO_MODE
  • 358 ERROR_VIO_ROW
  • 359 ERROR_VIO_COL
  • 421 ERROR_VIO_INVALID_PARMS
  • 436 ERROR_VIO_INVALID_HANDLE

Remarks

If a string read comes to the end of the line and is not complete, it continues at the beginning of the next line. If the read comes to the end of the screen and is not complete, it terminates, and the length is set to the number of characters read.