VioWrtCharStr: Difference between revisions

Revision as of 19:26, 26 February 2017

Writes a character string to the display.

Syntax

VioWrtCharStr (CharStr, Length, Row, Column, VioHandle)

Parameters

CharStr (PCH) - input: String to be written.; Address of the character string to be written.
Length (ULONG) - input: Length of character string.; Length, in bytes, of the character string.
Row (ULONG) - input: Starting row position.
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.

Return Code

rc (APIRET) - returns

VioWrtCharStr 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 to the display.
 ==Syntax==
-<PRE>
+  VioWrtCharStr (CharStr, Length, Row, Column, VioHandle)
-#define INCL_VIO
-#include <os2.h>
-PCH       CharStr;    /*  String to be written. */
-ULONG     Length;     /*  Length of character string. */
-ULONG     Row;        /*  Starting row position. */
-ULONG     Column;     /*  Starting column position. */
-HVIO      VioHandle;  /*  VIO presentation-space handle. */
-APIRET    rc;         /*  Return code. */
-rc = VioWrtCharStr(CharStr, Length, Row, Column, 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 of character string.
-; Length (ULONG) - input : Length of character string.
+:Length, in bytes, of the character string.
-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.
+;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]].
-; 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.
 ==Return Code==
   rc (APIRET) - returns
 VioWrtCharStr returns one of the following values:
   *   0  NO_ERROR
@@ Line 45: / Line 27: @@
 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.
-==Example Code==
+[[Category:Vio]]
-==Related Functions==
-[[Category:The OS/2 API Project]]