VioWrtCharStrAtt: Difference between revisions

Latest revision as of 22:03, 1 January 2020

Writes a character string with repeated attributes to the display.

Syntax

VioWrtCharStrAtt (CharStr, Length, Row, Column, Attr, VioHandle)

Parameters

CharStr (PCH) - input: String to be written.; Address of the character string to be written.
Length (ULONG) - input: Length, in bytes, of the character string.
Row (ULONG) - input: Starting row position.
Column (ULONG) - input: Starting column position.
Attr (PBYTE) - input: Attribute to be replicated.; Address of the attributes (1 or 3 bytes) to be used in the display buffer for each character of the string written.
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: VioWrtCharStrAtt 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 write gets to the end of the line and is not complete, it continues at the beginning of the next line. If the write gets to the end of the screen, it terminates.

@@ Line 1: / Line 1: @@
-==Description==
+Writes a character string with repeated attributes to the display.
-Writes a character string with repeated attributes to the display.
 ==Syntax==
-<PRE>
+  VioWrtCharStrAtt (CharStr, Length, Row, Column, Attr, VioHandle)
-#define INCL_VIO
-#include <os2.h>
-PCH       CharStr;    /*  String to be written. */
-ULONG     Length;     /*  Length, in bytes, of the character string. */
-ULONG     Row;        /*  Starting row position. */
-ULONG     Column;     /*  Starting column position. */
-PBYTE     Attr;       /*  Attribute to be replicated. */
-HVIO      VioHandle;  /*  VIO presentation-space handle. */
-APIRET    rc;         /*  Return code. */
-rc = VioWrtCharStrAtt(CharStr, Length, Row, Column, Attr, VioHandle);
-</PRE>
 ==Parameters==
-; CharStr (PCH) - input :  String to be written.
+;CharStr (PCH) - input:  String to be written.
-Address of the character string to be written.
+:Address of the character string to be written.
+;Length (ULONG) - input: Length, in bytes, of the character string.
-; Length (ULONG) - input : Length, in bytes, of the character string.
+;Row (ULONG) - input: Starting row position.
+;Column (ULONG) - input: Starting column position.
-; Row (ULONG) - input : Starting row position.
+;Attr (PBYTE) - input: Attribute to be replicated.
+:Address of the attributes (1 or 3 bytes) to be used in the display buffer for each character of the string written.
-; Column (ULONG) - input :  Starting column position.
+;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]].
-; Attr (PBYTE) - input :  Attribute to be replicated.
-Address of the attributes (1 or 3 bytes) to be used in the display buffer for each character of the string written.
-; 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:VioWrtCharStrAtt returns one of the following values:
- rc (APIRET) - returns
+*0 NO_ERROR
+*355 ERROR_VIO_MODE
-VioWrtCharStrAtt returns one of the following values:
+*358 ERROR_VIO_ROW
+*359 ERROR_VIO_COL
-* 0          NO_ERROR
+*421 ERROR_VIO_INVALID_PARMS
-* 355        ERROR_VIO_MODE
+*436 ERROR_VIO_INVALID_HANDLE
-* 358        ERROR_VIO_ROW
-* 359        ERROR_VIO_COL
-* 421        ERROR_VIO_INVALID_PARMS
-* 436        ERROR_VIO_INVALID_HANDLE
 ==Remarks==
 If a string write gets to the end of the line and is not complete, it continues at the beginning of the next line. If the write gets to the end of the screen, it terminates.
-[[Category:The OS/2 API Project]]
+[[Category:Vio]]