carta
wdelch(3ncurses)

wdelch3ncurses

Delete a character from a curses window

Part of delch(3ncurses).

Overview

wdelch deletes the character at the cursor position in win. It moves all characters to the right of the cursor on the same line to the left one position and replaces the contents of the rightmost position on the line with the window's background character; see bkgd(3NCURSES) (wide-character API users: bkgrnd(3NCURSES)). The cursor position does not change (after moving to (y, x), if specified). ncurses(3NCURSES) describes the variants of this function.

Return value

These functions return OK on success and ERR on failure.

In ncurses, they return ERR if win is NULL.

Functions prefixed with “mv” first perform cursor movement and fail if the position (y, x) is outside the window boundaries.

Notes

delch, mvdelch, and mvwdelch may be implemented as macros.

A terminal's delete_character (dch1) capability is not necessarily employed.

Portability

X/Open Curses Issue 4 describes these functions. It specifies no error conditions for them.

SVr4 describes a successful return value only as “an integer value other than ERR”.

History

  • Debian 13 (Trixie): the text shown here
  • Debian 12 (Bookworm)
  • Debian 11 (Bullseye)
  • Debian 10 (Buster)
  • Debian 9 (Stretch) to Debian 7 (Wheezy)
  • Debian 6.0 (Squeeze) to Debian 4.0 (Etch)
  • Debian 3.1 (Sarge)
  • Debian 3.0 (Woody)

History

SVr2 (1984) introduced wdelch.

From ncurses-doc 6.5+20250216-2 in Debian 13 (Trixie). Parsed by carta from the page's man source.