Jump to content

VioGetCurPos (FAPI): Difference between revisions

From EDM2
Created page with "==Description== This call returns the coordinates of the cursor. ==Syntax== <PRE> VioGetCurPos (Row, Column, VioHandle) </PRE> ==Parameters== ; Row (PUSHORT) - output ..."
 
Ak120 (talk | contribs)
mNo edit summary
Line 1: Line 1:
==Description==
This call returns the coordinates of the cursor.
This call returns the coordinates of the cursor.


==Syntax==
==Syntax==
<PRE>
  VioGetCurPos (Row, Column, VioHandle)
  VioGetCurPos


    (Row, Column, VioHandle)
</PRE>
==Parameters==
==Parameters==
; Row (PUSHORT) - output : Address of the current Row position of the cursor where 0 is the top row.  
;Row (PUSHORT) - output : Address of the current Row position of the cursor where 0 is the top row.
 
;Column (PUSHORT) - output : Address of the current column position of the cursor where 0 is the leftmost column.
; Column (PUSHORT) - output : Address of the current column position of the cursor where 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:
Return code descriptions are:
* 0          NO_ERROR  
* 0          NO_ERROR  
* 355        ERROR_VIO_MODE  
* 355        ERROR_VIO_MODE  
Line 26: Line 18:


==Remarks==
==Remarks==


==Example Code==
==Example Code==
Line 57: Line 48:
*
*


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

Revision as of 00:38, 27 February 2017

This call returns the coordinates of the cursor.

Syntax

VioGetCurPos (Row, Column, VioHandle)

Parameters

Row (PUSHORT) - output
Address of the current Row position of the cursor where 0 is the top row.
Column (PUSHORT) - output
Address of the current column position of the cursor where 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
  • 436 ERROR_VIO_INVALID_HANDLE
  • 465 ERROR_VIO_DETACHED

Remarks

Example Code

C Binding

#define INCL_VIO

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

PUSHORT          Row;           /* Row return data */
PUSHORT          Column;        /* Column return data */
HVIO             VioHandle;     /* Vio handle */

USHORT           rc;            /* return code */

MASM Binding

EXTRN  VioGetCurPos:FAR
INCL_VIO            EQU 1

PUSH@  WORD    Row           ;Row return data
PUSH@  WORD    Column        ;Column return data
PUSH   WORD    VioHandle     ;Vio handle
CALL   VioGetCurPos

Returns WORD

Related Functions