curs_set Subroutine

Purpose

Sets the cursor visibility.

Library

Curses Library (libcurses.a)

Syntax

#include <curses.h>

int curs_set(int  visibility);

Description

The curs_set subroutine sets the appearance of the cursor based on the value of visibility:

Value of visibility   Appearance of Cursor
Item Description
0 invisible
1 terminal-specific normal mode
2 terminal-specific high visibility mode

The terminal does not necessarily support all the above values.

Parameters

Item Description
Visibility Sets the cursor state. You can set the cursor state to one of the following:
0
Invisible
1
Visible
2
Very visible

Return Values

If the terminal supports the cursor mode specified by visibility, then the cur_set subroutine returns the previous cursor state. Otherwise, the subroutine returns ERR.

Examples

To set the cursor state to invisible, use:

curs_set(0);