en:docs:fapi:viowrtcellstr

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
en:docs:fapi:viowrtcellstr [2018/09/01 10:11] – created prokusheven:docs:fapi:viowrtcellstr [2021/09/19 04:19] (current) prokushev
Line 1: Line 1:
 +{{page>en:templates:fapiint}} 
 +====== VioWrtCellStr ====== 
 + 
 This call writes a string of character-attribute pairs (cells) to the display.  This call writes a string of character-attribute pairs (cells) to the display. 
  
-==Syntax==+===== Syntax ===== 
 +<code c>
  VioWrtCellStr (CellStr, Length, Row, Column, VioHandle)  VioWrtCellStr (CellStr, Length, Row, Column, VioHandle)
 +</code>
 +===== Parameters =====
  
-==Parameters== +  * CellStr (PCH) - input : Address of the string of character-attribute(s) cells to be written. 
-;CellStr (PCH) - input : Address of the string of character-attribute(s) cells to be written. +  Length (USHORT) - input : Length, in bytes, of the string to be written. Each character-attribute(s) cell is 2 or 4 bytes. 
-;Length (USHORT) - input : Length, in bytes, of the string to be written. Each character-attribute(s) cell is 2 or 4 bytes. +  Row (USHORT) - input : Starting cursor row. 
-;Row (USHORT) - input : Starting cursor row. +  Column (USHORT) - input : Starting cursor column. 
-;Column (USHORT) - input : Starting cursor 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. 
-;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  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 ===== 
 If a string write gets to the end of the line and is not complete, the string write continues at the beginning of the next line. If the write gets to the end of the screen, the write terminates. If a string write gets to the end of the line and is not complete, the string write continues at the beginning of the next line. If the write gets to the end of the screen, the write terminates.
  
-===PM Considerations===+==== PM Considerations ===
 Write a character-attribute string to the Advanced VIO presentation space. The caller must specify the starting location on the presentation space where the string is to be written.  Write a character-attribute string to the Advanced VIO presentation space. The caller must specify the starting location on the presentation space where the string is to be written. 
-==Example Code== +===== Bindings ===== 
-=== C Binding=== + 
-<PRE>+==== C Binding==== 
 +<code c>
 #define INCL_VIO #define INCL_VIO
  
Line 41: Line 51:
  
 USHORT           rc;            /* return code */ USHORT           rc;            /* return code */
-</PRE>+</code>
  
-===MASM Binding=== +====MASM Binding==== 
-<PRE>+<code asm>
 EXTRN  VioWrtCellStr:FAR EXTRN  VioWrtCellStr:FAR
 INCL_VIO            EQU 1 INCL_VIO            EQU 1
Line 56: Line 66:
  
 Returns WORD Returns WORD
-</PRE> +</code>
- +
  
-====== Note ======+===== Note =====
  
 Text based on [[http://www.edm2.com/index.php/VioWrtCellStr_(FAPI)]] Text based on [[http://www.edm2.com/index.php/VioWrtCellStr_(FAPI)]]