border_set.3x (2010 09)

border_set(3X) border_set(3X)

(ENHANCED CURSES)

NAME

border_set, wborder_set — draw borders from complex characters and renditions

SYNOPSIS

#include <curses.h>

int border_set(const cchar_t *ls, const cchar_t *rs, const cchar_t *ts,

const cchar_t *bs, const cchar_t *tl, const cchar_t *tr,

const cchar_t *bl, const cchar_t *br);

int wborder_set(WINDOW *win, const cchar_t *ls, const cchar_t *rs,

const cchar_t *ts, const cchar_t *bs,

const cchar_t *tl, const cchar_t *tr,

const cchar_t *bl, const cchar_t *br);

DESCRIPTION

The border_set() and wborder_set()

functions draw a border around the edges of the current or

speciﬁed 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 spacing complex characters with

renditions, which have the following uses in drawing the border:

Argument Default

Name Usage Value

ls Starting-column side WACS_VLINE

rs Ending-column side WACS_VLINE

ts First-line side WACS_HLINE

bs Last-line side WACS_HLINE

tl Corner of the ﬁrst line and the starting column WACS_ULCORNER

tr Corner of the ﬁrst line and the ending column WACS_URCORNER

bl Corner of the last line and the starting column WACS_BLCORNER

br Corner of the last line and the ending column WACS_BRCORNER

If the value of any argument in the left-hand column is a null pointer, 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 char-

acter, the results are undeﬁned.

RETURN VALUE

Upon successful completion, these functions return OK. Otherwise, they return ERR.

ERRORS

No errors are deﬁned.