Jump to content

VioWrtNChar (FAPI): Difference between revisions

From EDM2
Created page with "==Description== VioWrtNChar writes a character to the display a specified number of times. ==Syntax== <PRE> VioWrtNChar (Char, Times, Row, Column, VioHandle) </PRE> ..."
 
Ak120 (talk | contribs)
mNo edit summary
Line 1: Line 1:
==Description==
VioWrtNChar writes a character to the display a specified number of times.
VioWrtNChar writes a character to the display a specified number of times.  


==Syntax==
==Syntax==
<PRE>
  VioWrtNChar (Char, Times, Row, Column, VioHandle)  
  VioWrtNChar
 
    (Char, Times, Row, Column, VioHandle)  
 
</PRE>


==Parameters==
==Parameters==
; Char (PCH) - input : Address of the character to be written.  
;Char (PCH) - input : Address of the character to be written.
 
;Times (USHORT) - input : Number of times to write the character.
; Times (USHORT) - input : Number of times to write the character.  
;Row (USHORT) - input : Starting cursor row.
 
;Column (USHORT) - input : Starting cursor column.
; Row (USHORT) - input : Starting cursor row.  
;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.
 
; 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.


==Return Code==
==Return Code==
  rc (USHORT) - return
  rc (USHORT) - return
Return code descriptions are:
Return code descriptions are:
* 0          NO_ERROR  
* 0          NO_ERROR  
* 355        ERROR_VIO_MODE  
* 355        ERROR_VIO_MODE  
Line 35: Line 23:
==Remarks==
==Remarks==
If a repeated write gets to the end of the line and is not complete, the write continues at the beginning of the next line. If the write gets to the end of the screen, the write terminates.
If a repeated write gets to the end of the line and is not complete, the 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 to the Advanced VIO presentation space a number of times. The caller must specify the starting location on the presentation space where the string is to be written.  
Write a character to the Advanced VIO presentation space a number of times. The caller must specify the starting location on the presentation space where the string is to be written.  


Line 75: Line 61:
*  
*  


[[Category:The OS/2 API Project]]
[[Category:Vio]]

Revision as of 19:01, 28 February 2017

VioWrtNChar writes a character to the display a specified number of times.

Syntax

VioWrtNChar (Char, Times, Row, Column, VioHandle) 

Parameters

Char (PCH) - input
Address of the character to be written.
Times (USHORT) - input
Number of times to write the character.
Row (USHORT) - input
Starting cursor row.
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.

Return Code

rc (USHORT) - return

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

If a repeated write gets to the end of the line and is not complete, the write continues at the beginning of the next line. If the write gets to the end of the screen, the write terminates.

PM Considerations

Write a character to the Advanced VIO presentation space a number of times. The caller must specify the starting location on the presentation space where the string is to be written.

Example Code

C Binding

#define INCL_VIO

USHORT  rc = VioWrtNChar(Char, Times, Row, Column, VioHandle);

PCH              Char;          /* Character to be written */
USHORT           Times;         /* Repeat count */
USHORT           Row;           /* Starting row position for output */
USHORT           Column;        /* Starting column position for output */
HVIO             VioHandle;     /* Video handle */

USHORT           rc;            /* return code */

MASM Binding

EXTRN  VioWrtNChar:FAR
INCL_VIO            EQU 1

PUSH@  OTHER   Char          ;Character to be written
PUSH   WORD    Times         ;Repeat count
PUSH   WORD    Row           ;Starting row position for output
PUSH   WORD    Column        ;Starting column position for output
PUSH   WORD    VioHandle     ;Video handle
CALL   VioWrtNChar

Returns WORD

Related Functions