en:docs:fapi:viogetcurtype

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
en:docs:fapi:viogetcurtype [2018/09/01 02:43] – created prokusheven:docs:fapi:viogetcurtype [2021/09/19 02:14] (current) – prokushev
Line 1: Line 1:
 +{{page>en:templates:fapiint}}
  
-==Syntax==+====== VioGetCurType ====== 
 + 
 +===== Syntax ===== 
 +<code c>
  VioGetCurType (CursorData, VioHandle)  VioGetCurType (CursorData, VioHandle)
 +</code>
 +===== Parameters =====
  
-==Parameters== +  * CursorData ([[PVIOCURSORINFO]]) - output :  Address of the cursor characteristics structure: 
-;CursorData (PVIOCURSORINFO) - output :  Address of the cursor characteristics structure:+    * startline ([[USHORT]]) : Horizontal scan line in the character cell that marks the top line of the cursor. If the character cell has n scan lines, 0 is the top scan line of the character cell and (n-1) is the bottom scan line.  
 +    * endline ([[USHORT]]) : Horizontal scan line in the character cell that marks the bottom line of the cursor. Scan lines within a character cell are numbered as defined in startline.  
 +    * cursorwidth ([[USHORT]]) : Width of the cursor. In text modes, cursorwidth is the number of columns. The maximum number supported by the OS/2 base video subsystem is 1. In graphics modes, cursorwidth is the number of pels.  
 +    * cursorattrib ([[USHORT]]) : A value of -1 denotes a hidden cursor, all other values in text mode denote normal cursor and in graphics mode denote color attribute.  
 +  * 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.
  
-startline (USHORT) : Horizontal scan line in the character cell that marks the top line of the cursor. If the character cell has n scan lines, 0 is the top scan line of the character cell and (n-1) is the bottom scan line. +===== Return Code =====
  
-endline (USHORT) : Horizontal scan line in the character cell that marks the bottom line of the cursor. Scan lines within a character cell are numbered as defined in startline. +rc ([[USHORT]]) - return
  
-cursorwidth (USHORT) : Width of the cursor. In text modes, cursorwidth is the number of columns. The maximum number supported by the OS/2 base video subsystem is 1. In graphics modes, cursorwidth is the number of pels. +Return code descriptions are:
  
-cursorattrib (USHORT) : A value of -1 denotes a hidden cursor, all other values in text mode denote normal cursor and in graphics mode denote color attribute. +  * 0         NO_ERROR  
 +  *355        ERROR_VIO_MODE  
 +  *436        ERROR_VIO_INVALID_HANDLE  
 +  *465        ERROR_VIO_DETACHED
  
-; 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.+===== Remarks =====
  
-==Return Code== +If CursorStartLine and CursorEndLine were originally specified as percentages on [[VioSetCurType]] (using negative values), the positive values into which they were translated are returned. Refer to [[VioSetCurType]] for more information on how percentages can be used to set CursorStartLine and CursorEndLine independent of the number of scan lines per character cell.
- rc (USHORT) - return +
-Return code descriptions are: +
-* 0         NO_ERROR  +
-*355        ERROR_VIO_MODE  +
-*436        ERROR_VIO_INVALID_HANDLE  +
-*465        ERROR_VIO_DETACHED+
  
-==Remarks== +==== Family API Considerations ====
-If CursorStartLine and CursorEndLine were originally specified as percentages on VioSetCurType (using negative values), the positive values into which they were translated are returned. Refer to VioSetCurType for more information on how percentages can be used to set CursorStartLine and CursorEndLine independent of the number of scan lines per character cell.+
  
-===Family API Considerations=== 
 In DOS mode, VioGetCurType returns only two values for cursorattrib: 0 = visible cursor, and -1 = hidden cursor. In DOS mode, VioGetCurType returns only two values for cursorattrib: 0 = visible cursor, and -1 = hidden cursor.
  
-==Example Code== +===== Bindings ===== 
-=== C Binding=== + 
-<PRE>+==== C Binding==== 
 +<code c>
 typedef struct _VIOCURSORINFO {  /* vioci */ typedef struct _VIOCURSORINFO {  /* vioci */
   USHORT   yStart;               /*cursor start line */   USHORT   yStart;               /*cursor start line */
Line 49: Line 55:
  
 USHORT           rc;            /* return code */ USHORT           rc;            /* return code */
-</PRE>+</code>
  
-===MASM Binding=== +====MASM Binding==== 
-<PRE>+<code asm>
 VIOCURSORINFO struc VIOCURSORINFO struc
   vioci_yStart dw  ? ;cursor start line   vioci_yStart dw  ? ;cursor start line
Line 68: Line 74:
  
 Returns WORD Returns WORD
-</PRE>+</code>
  
  
  
-====== Note ======+===== Note =====
  
 Text based on [[http://www.edm2.com/index.php/VioGetCurType_(FAPI)]] Text based on [[http://www.edm2.com/index.php/VioGetCurType_(FAPI)]]