Jump to content

VioWrtNAttr (FAPI): Difference between revisions

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


==Syntax==
==Syntax==
<PRE>
  VioWrtNAttr (Attr, Times, Row, Column, VioHandle)
  VioWrtNAttr
 
    (Attr, Times, Row, Column, VioHandle)  
</PRE>


==Parameters==
==Parameters==
; Attr (PBYTE) - input : Address of the attribute(s) (1 or 3 bytes) to be written.  
;Attr (PBYTE) - input : Address of the attribute(s) (1 or 3 bytes) to be written.
 
;Times (USHORT) - input : Number of times to write the attribute.
; Times (USHORT) - input : Number of times to write the attribute.  
;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 34: 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 an attribute code to the Advanced VIO presentation space a specified number of times. The caller must specify the starting location on the presentation space where the string is to be written.  
Write an attribute code to the Advanced VIO presentation space a specified number of times. The caller must specify the starting location on the presentation space where the string is to be written.  


Line 74: Line 61:
*  
*  


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

Revision as of 18:58, 28 February 2017

This call writes an attribute to the display a specified number of times.

Syntax

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

Parameters

Attr (PBYTE) - input
Address of the attribute(s) (1 or 3 bytes) to be written.
Times (USHORT) - input
Number of times to write the attribute.
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 an attribute code to the Advanced VIO presentation space a specified 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 = VioWrtNAttr(Attr, Times, Row, Column, VioHandle);

PBYTE            Attr;          /* Attribute 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  VioWrtNAttr:FAR
INCL_VIO            EQU 1

PUSH@  OTHER   Attr          ;Attribute 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   VioWrtNAttr

Returns WORD

Related Functions