border.3x (2010 09)

b
border(3X) border(3X)
(ENHANCED CURSES)
NAME
border, wborder — draw borders from single-byte characters and renditions
SYNOPSIS
#include <curses.h>
int border(chtype ls, chtype rs, chtype ts, chtype bs, chtype tl,
chtype tr, chtype bl, chtype br);
int wborder(WINDOW *win, chtype ls, chtype rs, chtype ts, chtype bs,
chtype tl, chtype tr, chtype bl, chtype br);
DESCRIPTION
The border() and wborder() functions draw a border around the edges of the current or specified
window. These functions do not advance the cursor position. These functions do not perform special
character processing. These functions do not perform wrapping.
The arguments in the left-hand column of the following table contain single-byte characters with rendi-
tions, which have the following uses in drawing the border:
Argument Default
Name Usage Value
ls Starting-column side ACS_VLINE
rs Ending-column side ACS_VLINE
ts First-line side ACS_HLINE
bs Last-line side ACS_HLINE
tl Corner of the first line and the starting column ACS_ULCORNER
tr Corner of the first line and the ending column ACS_URCORNER
bl Corner of the last line and the starting column ACS_BLCORNER
br Corner of the last line and the ending column ACS_BRCORNER
If the value of any argument in the left-hand column is 0, then the default value in the right-hand column
is used. If the value of any argument in the left-hand column is a multi-column character, the results are
undefined.
RETURN VALUE
Upon successful completion, these functions return OK. Otherwise, they return ERR.
ERRORS
No errors are defined.
APPLICATION 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.
SEE ALSO
border_set(3X), box(3X), hline(3X), <curses.h>.
CHANGE HISTORY
First released in X/Open Curses, Issue 4.
HP-UX 11i Version 3: September 2010 − 1 − Hewlett-Packard Company 1