VioWrtCellStr: Difference between revisions

Latest revision as of 21:11, 1 January 2020

Writes a string of character-attribute pairs (cells) to the display.

Syntax

VioWrtCellStr(CellStr, Length, Row, Column, VioHandle)

Parameters

CellStr (ULONG) - input: String to be written.; Address of the string of character-attribute cells to be written.
Length (ULONG) - input: Length of string.; Length, in bytes, of the string to be written. Each character-attribute cell is 2 or 4 bytes.
Row (ULONG) - input: Starting row position for output.
Column (ULONG) - input: Starting column position for output.
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: VioWrtCellStr 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 string of character-attribute pairs (cells) to the display.
-Writes a string of character-attribute pairs (cells) to the display.
 ==Syntax==
-<PRE>
+ VioWrtCellStr(CellStr, Length, Row, Column, VioHandle)
-#define INCL_VIO
-#include <os2.h>
-ULONG     CellStr;    /*  String to be written. */
-ULONG     Length;     /*  Length of string. */
-ULONG     Row;        /*  Starting row position for output. */
-ULONG     Column;     /*  Starting column position for output. */
-HVIO      VioHandle;  /*  VIO presentation-space handle. */
-APIRET    rc;         /*  Return code. */
-rc = VioWrtCellStr(CellStr, Length, Row, Column,
-       VioHandle);
-</PRE>
 ==Parameters==
-; CellStr (ULONG) - input : String to be written.
+;CellStr (ULONG) - input: String to be written.
-Address of the string of character-attribute cells to be written.
+:Address of the string of character-attribute cells to be written.
+;Length (ULONG) - input: Length of string.
-; Length (ULONG) - input : Length of string.
+:Length, in bytes, of the string to be written. Each character-attribute cell is 2 or 4 bytes.
-Length, in bytes, of the string to be written. Each character-attribute cell is 2 or 4 bytes.
+;Row (ULONG) - input: Starting row position for output.
+;Column (ULONG) - input: Starting column position for output.
-; Row (ULONG) - input : Starting row position for output.
+;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 for output.
-; 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
+;rc (APIRET) - returns:VioWrtCellStr returns one of the following values:
+*0 NO_ERROR
-VioWrtCellStr returns one of the following values:
+*355 ERROR_VIO_MODE
+*358 ERROR_VIO_ROW
-* 0          NO_ERROR
+*359 ERROR_VIO_COL
-* 355        ERROR_VIO_MODE
+*421 ERROR_VIO_INVALID_PARMS
-* 358        ERROR_VIO_ROW
+*436 ERROR_VIO_INVALID_HANDLE
-* 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.
-==Example Code==
-<PRE>
-</PRE>
-==Related Functions==
-* [[OS2 API:CPI:
-[[Category:The OS/2 API Project]]
+[[Category:Vio]]