Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
en:docs:fapi:viosetcurtype [2018/09/01 10:02] – created prokushev | en:docs:fapi:viosetcurtype [2021/09/19 04:10] (current) – prokushev | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | {{page> | ||
+ | ====== VioSetCurType ====== | ||
+ | |||
This call sets the cursor type. | This call sets the cursor type. | ||
- | ==Syntax== | + | ===== Syntax |
- | | + | <code c> |
+ | VioSetCurType (CursorData, | ||
+ | </ | ||
+ | |||
+ | ===== Parameters ===== | ||
+ | |||
+ | * CursorData ([[PVIOCURSORINFO]]) - input : 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. The maximum value allowed is 31. | ||
+ | *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. | ||
+ | A value of 0 specifies the default width. In text modes, this is 1 column. In graphics modes, this is the number of pels equivalent to the width of one character. | ||
+ | * cursorattrib ([[USHORT]]) : A value of -1 denotes a hidden cursor, all other values denote a normal cursor. | ||
+ | *VioHandle ([[HVIO]]) - input : This must be zero unless the caller is a Presentation Manager application, | ||
+ | |||
+ | ===== Return Code ===== | ||
- | ==Parameters== | + | rc ([[USHORT]]) - return |
- | ;CursorData (PVIOCURSORINFO) - input : Address of the cursor characteristics structure: | + | |
- | : | + | |
- | :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. The maximum value allowed is 31. | + | |
- | : | + | |
- | ::A value of 0 specifies the default width. In text modes, this is 1 column. In graphics modes, this is the number of pels equivalent to the width of one character. | + | |
- | : | + | |
- | ;VioHandle (HVIO) - input : This must be zero unless the caller is a Presentation Manager application, | + | |
- | ==Return Code== | ||
- | rc (USHORT) - return | ||
Return code descriptions are: | Return code descriptions are: | ||
- | * 0 NO_ERROR | + | |
- | * 355 ERROR_VIO_MODE | + | * 355 ERROR_VIO_MODE |
- | * 356 ERROR_VIO_WIDTH | + | * 356 ERROR_VIO_WIDTH |
- | * 421 ERROR_VIO_INVALID_PARMS | + | * 421 ERROR_VIO_INVALID_PARMS |
- | * 436 ERROR_VIO_INVALID_HANDLE | + | * 436 ERROR_VIO_INVALID_HANDLE |
- | * 465 ERROR_VIO_DETACHED | + | * 465 ERROR_VIO_DETACHED |
- | ==Remarks== | + | ===== Remarks |
- | ==Example Code== | + | |
- | === C Binding=== | + | ===== Bindings ===== |
- | <PRE> | + | |
+ | ==== C Binding==== | ||
+ | <code c> | ||
typedef struct _VIOCURSORINFO { /* vioci */ | typedef struct _VIOCURSORINFO { /* vioci */ | ||
USHORT | USHORT | ||
Line 45: | Line 54: | ||
USHORT | USHORT | ||
- | </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 64: | Line 73: | ||
Returns WORD | Returns WORD | ||
- | </PRE> | + | </code> |
- | + | ||
- | + | ||
- | ====== Note ====== | + | ===== Note ===== |
Text based on [[http:// | Text based on [[http:// |