en:docs:fapi:viowrttty

Differences

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

Link to this comparison view

Next revision
Previous revision
en:docs:fapi:viowrttty [2018/09/01 11:04] – created prokusheven:docs:fapi:viowrttty [2021/09/19 04:43] (current) prokushev
Line 1: Line 1:
 +{{page>en:templates:fapiint}}
 +
 +====== VioWrtTTY ======
 +===== Brief =====
  
 This call writes a character string to the display starting at the current cursor position. This call writes a character string to the display starting at the current cursor position.
Line 4: Line 8:
 At the completion of the write, the cursor is positioned at the first position beyond the end of the string. At the completion of the write, the cursor is positioned at the first position beyond the end of the string.
  
-==Syntax==+===== Syntax ===== 
 + 
 +<code c>
  VioWrtTTY (CharStr, Length, VioHandle)  VioWrtTTY (CharStr, Length, VioHandle)
 +</code>
  
-==Parameters== +===== Parameters =====
-;CharStr ([[PCH]]) - input : Address of the string to be written. +
-;Length ([[USHORT]]) - input :  Length of the character string in bytes. +
-;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==+  * CharStr ([[PCH]]) - input : Address of the string to be written. 
 +  * Length ([[USHORT]]) - input :  Length of the character string in bytes. 
 +  * 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  rc (USHORT) - return
 +
 Return code descriptions are: Return code descriptions are:
-* 0    NO_ERROR 
-* 355  ERROR_VIO_MODE 
-* 436  ERROR_VIO_INVALID_HANDLE 
-* 465  ERROR_VIO_DETACHED 
  
-==Remarks==+  * 0    NO_ERROR 
 +  * 355  ERROR_VIO_MODE 
 +  * 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 screen is scrolled, and the write continues until completed. 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 screen is scrolled, and the write continues until completed.
  
Line 29: Line 39:
 VioWrtTTY is supported in graphics mode to process ANSI sequences. This allows the application to enter and exit a graphics mode. VioWrtTTY is supported in graphics mode to process ANSI sequences. This allows the application to enter and exit a graphics mode.
  
-===PM Considerations===+==== Presentation Manager Considerations ====
 Write a character string from the current cursor position in TTY mode to the Advanced VIO presentation space. The cursor is positioned after the last character written at the end of the write. Write a character string from the current cursor position in TTY mode to the Advanced VIO presentation space. The cursor is positioned after the last character written at the end of the write.
  
-==Bindings== +===== Bindings ===== 
-=== C Binding=== +==== C Binding ==== 
-<PRE>+<code c>
 #define INCL_VIO #define INCL_VIO
  
Line 44: Line 54:
  
 USHORT  rc;            /* return code */ USHORT  rc;            /* return code */
-</PRE>+</code>
  
-===MASM Binding=== +==== MASM Binding ==== 
-<PRE>+<code asm>
 EXTRN      VioWrtTTY:FAR EXTRN      VioWrtTTY:FAR
 INCL_VIO   EQU 1 INCL_VIO   EQU 1
Line 57: Line 67:
  
 Returns WORD Returns WORD
-</PRE> +</code>
- +
  
-====== Note ======+===== Note =====
  
 Text based on [[http://www.edm2.com/index.php/VioWrtTTY_(FAPI)]] Text based on [[http://www.edm2.com/index.php/VioWrtTTY_(FAPI)]]