unctrl Subroutine

Purpose

Generates a printable representation of a character.

Library

Curses Library (libcurses.a)

Syntax

#include <curses.h>

char *unctrl
(chtype c);

Description

The unctrl subroutine generates a character string that is a printable representation of c. If c is a control character, it is converted to the ^X notation. If c contains rendition information, the effect is undefined.

Parameters

Return Values

Upon successful completion, the unctrl subroutine returns the generated string. Otherwise, it returns a null pointer.

Examples

To display a printable representation of the newline character, enter:

char *new_line;
int my_character;
addstr ("Hit the enter key.");
my_character=getch();
new_line=unctrl (my_character);
printw (Newline=%s", new_line);
refresh();

This prints, "newline=^J".