VioWrtNAttr: Difference between revisions

Latest revision as of 21:34, 1 January 2020

Writes an attribute to the display a specified number of times.

Syntax

VioWrtNAttr(Attr, Times, Row, Column, VioHandle)

Parameters

Attr (PBYTE) - input: Attribute to be written.; Address of the attributes (1 or 3 bytes) to be written.
Times (ULONG) - input: Repeat count.; The number of times to write the attribute.
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: VioWrtNAttr 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 repeated 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 an attribute to the display a specified number of times.
 ==Syntax==
-<PRE>
+ VioWrtNAttr(Attr, Times, Row, Column, VioHandle)
-#define INCL_VIO
-#include <os2.h>
-PBYTE     Attr;       /*  Attribute to be written. */
-ULONG     Times;      /*  Repeat count. */
-ULONG     Row;        /*  Starting row position. */
-ULONG     Column;     /*  Starting column position. */
-HVIO      VioHandle;  /*  VIO presentation-space handle. */
-APIRET    rc;         /*  Return code. */
-rc = VioWrtNAttr(Attr, Times, Row, Column, VioHandle);
-</PRE>
 ==Parameters==
-; Attr (PBYTE) - input : Attribute to be written.
+;Attr (PBYTE) - input: Attribute to be written.
-Address of the attributes (1 or 3 bytes) to be written.
+:Address of the attributes (1 or 3 bytes) to be written.
+;Times (ULONG) - input: Repeat count.
-; Times (ULONG) - input : Repeat count.
+:The number of times to write the attribute.
-The number of times to write the attribute.
+;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:VioWrtNAttr returns one of the following values:
- rc (APIRET) - returns
+*0 NO_ERROR
+*355 ERROR_VIO_MODE
-VioWrtNAttr 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 repeated 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]]