box(3curses)

box -- draw borders from single-byte characters and renditions

Synopsis

cc [options] file -lcurses

#include <curses.h>

int box(WINDOW *win, chtype verch, chtype horch);

Description

The box(3curses) function draws a border around the edges of the specified window. This function does not advance the cursor position. This function does not perform special character processing. This function does not perform wrapping.

The function box(win, verch, horch) has an effect equivalent to:

   wborder(win, verch, verch, horch, horch, 0, 0, 0, 0);

Return value

Upon successful completion, box(3curses) returns OK. Otherwise, it returns ERR.

Errors

No errors are defined.

Usage

These 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.

Standards Conformance

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

References

border(3curses), box_set(3curses), hline(3curses), curses(4)