VioReadCellStr

This call reads a string of character-attribute pairs (cells) from the screen, starting at the specified location.

VioReadCellStr

(CellStr, Length, Row, Column, VioHandle)

CellStr (PCH) - output

Address of the buffer where the cell string is returned.
Length (PUSHORT) - input/output
Address of the buffer length in bytes. Length must take into account that each character-attribute(s) entry in the buffer is 2 or 4 bytes. If the length of the buffer is not sufficient, the last entry is not complete.
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, in which case it must be the value returned by VioGetPs.
rc (USHORT) - return
Return code descriptions are:
• NO_ERROR 355
  ERROR_VIO_MODE
  358
  ERROR_VIO_ROW
  359
  ERROR_VIO_COL
  436
  ERROR_VIO_INVALID_HANDLE
  465
  ERROR_VIO_DETACHED
  Remarks

  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

  VioReadCellStr reads a string of character/attributes (or cells) from the Advanced VIO presentation space starting at the specified location.

  ---

  [Back: VioPrtScToggle]
  [Next: VioReadCharStr]