Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

◄Overview►                                            ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
 
#define INCL_VIO
 
USHORT VioGetCurType(pviociCursor, hvio)
PVIOCURSORINFO pviociCursor;    /* pointer to structure for cursor info */
HVIO hvio;                      /* video handle                         */
 
The VioGetCurType function retrieves information about the cursor type. This
information defines the height and width of the cursor, as well as whether
it is currently visible. The VioGetCurType function is a family API
function.
 
Parameter     Description
────────────────────────────────────────────────────────────────────────────
 
pviociCursor  Points to the VIOCURSORINFO structure that receives
              information about the cursor type.
 
hvio          Identifies an advanced video-input-and-output (AVIO)
              presentation space. For AVIO programs, this handle must have
              been created previously using the VioCreatePS function. For
              other programs, hvio must be NULL.
 
Return Value
 
The return value is zero if the function is successful. Otherwise, it is an
error value, which may be the following:
 
     ERROR_VIO_INVALID_HANDLE
 
Example
 
This example calls VioGetCurType to retrieve the current cursor type,
changes the attribute to hidden or visible (the opposite of what it was),
and calls VioSetCurType to set the new cursor type:
 
VIOCURSORINFO viociCursor;
VioGetCurType(&viociCursor, 0); /* retrieves current cursor type     */
viociCursor.attr =              /* flips attribute to hidden/visible */
    (viociCursor.attr == -1) ? 0 : -1;
VioSetCurType(&viociCursor, 0); /* sets new cursor type              */
 
See Also
 
VioGetCurPos, VioSetCurType, VioCreatePS, VIOCURSORINFO
 
                                      ♦