Jump to content

VioSetCurPos (FAPI): Difference between revisions

From EDM2
Created page with "==Description== This call sets the cursor's coordinates on the screen. ==Syntax== <PRE> VioSetCurPos (Row, Column, VioHandle) </PRE> ==Parameters== ; Row (USHORT) - i..."
 
Ak120 (talk | contribs)
mNo edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Description==
This call sets the cursor's coordinates on the screen.
This call sets the cursor's coordinates on the screen.


==Syntax==
==Syntax==
<PRE>
  VioSetCurPos (Row, Column, VioHandle)
  VioSetCurPos
 
    (Row, Column, VioHandle)
</PRE>


==Parameters==
==Parameters==
; Row (USHORT) - input : New cursor row position, 0 is the top row.  
;Row (USHORT) - input : New cursor row position, 0 is the top row.
 
;Column (USHORT) - input : New cursor column position, 0 is the leftmost column.
; Column (USHORT) - input : New cursor column position, 0 is the leftmost 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.
 
; 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:
 
*0 NO_ERROR
Return code descriptions are:
*355 ERROR_VIO_MODE
 
*358 ERROR_VIO_ROW
* 0         NO_ERROR  
*359 ERROR_VIO_COL
* 355       ERROR_VIO_MODE  
*436 ERROR_VIO_INVALID_HANDLE
* 358       ERROR_VIO_ROW  
*465 ERROR_VIO_DETACHED
* 359       ERROR_VIO_COL  
* 436       ERROR_VIO_INVALID_HANDLE  
* 465       ERROR_VIO_DETACHED
 
==Remarks==


==Example Code==
==Bindings==
=== C Binding===
===C===
<PRE>
<PRE>
#define INCL_VIO
#define INCL_VIO
Line 37: Line 25:
USHORT  rc = VioSetCurPos(Row, Column, VioHandle);
USHORT  rc = VioSetCurPos(Row, Column, VioHandle);


USHORT           Row;          /* Row data */
USHORT Row;          /* Row data */
USHORT           Column;        /* Column data */
USHORT Column;        /* Column data */
HVIO             VioHandle;    /* Video handle */
HVIO   VioHandle;    /* Video handle */


USHORT           rc;            /* return code */
USHORT rc;            /* return code */
</PRE>
</PRE>


===MASM Binding===
===MASM===
<PRE>
<PRE>
EXTRN  VioSetCurPos:FAR
EXTRN  VioSetCurPos:FAR
Line 58: Line 46:


==Related Functions==
==Related Functions==
*  
* VioGetCurPos


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

Latest revision as of 15:44, 28 February 2020

This call sets the cursor's coordinates on the screen.

Syntax

VioSetCurPos (Row, Column, VioHandle)

Parameters

Row (USHORT) - input
New cursor row position, 0 is the top row.
Column (USHORT) - input
New cursor column position, 0 is the leftmost 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

Bindings

C

#define INCL_VIO

USHORT  rc = VioSetCurPos(Row, Column, VioHandle);

USHORT  Row;           /* Row data */
USHORT  Column;        /* Column data */
HVIO    VioHandle;     /* Video handle */

USHORT  rc;            /* return code */

MASM

EXTRN  VioSetCurPos:FAR
INCL_VIO            EQU 1

PUSH   WORD    Row           ;Row data
PUSH   WORD    Column        ;Column data
PUSH   WORD    VioHandle     ;Video handle
CALL   VioSetCurPos

Returns WORD

Related Functions

  • VioGetCurPos