erasechar(3curses)

erasechar -- terminal environment query functions

Synopsis

cc [options] file -lcurses

#include <curses.h>

char erasechar(void);

int erasewchar(wchar_t *ch);

char killchar(void);

int killwchar(wchar_t *ch);

Description

The erasechar(3curses) function returns the current erase character. The erasewchar(3curses) function stores the current erase character in the object pointed to by ch. If no erase character has been defined, the function will fail and the object pointed to by ch will not be changed.

The killchar(3curses) function returns the current line kill character. The killwchar(3curses) function stores the current line kill character in the object pointed to by ch. If no line kill character has been defined, the function will fail and the object pointed to by ch will not be changed.

Return value

The erasechar(3curses) function returns the erase character and killchar(3curses) returns the line kill character. The return value is unspecified when these characters are multi-byte characters.

Upon successful completion, erasewchar(3curses) and killwchar(3curses) return OK. Otherwise, they return ERR.

Errors

No errors are defined.

Usage

The erasechar(3curses) and killchar(3curses) functions are only guaranteed to operate reliably on character sets in which each character fits into a single byte, whose attributes can be expressed using only constants with the A_ prefix. Moreover, they do not reliably indicate cases in which when the erase or line kill character, respectively, has not been defined. The erasewchar(3curses) and killwchar(3curses) functions overcome these limitations.

Standards Conformance

The Single UNIX Specification, Version 2; The Open Group.

References

``Attributes'', clearok(3curses), delscreen(3curses), tcgetattr(3C), curses(4)