# curs_border_set

## NAME



           **border_set** , **wborder_set** , **box_set** , **hline_set** , **whline_set** ,
           **mvhline_set** , **mvwhline_set** , **vline_set** , **wvline_set** , **mvvline_set** ,
           **mvwvline_set** - create **curses** borders or lines using 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_**);**
           **int box_set(**
              **WINDOW *win** ,
              **const cchar_t ***_verch_ ,
              **const cchar_t ***_horch_**);**
           **int hline_set(**
              **const cchar_t ***_wch_ , **int** _n_**);**
           **int whline_set(**
              **WINDOW ***_win_ ,
              **const cchar_t ***_wch_ , **int** _n_**);**
           **int mvhline_set(**
              **int** _y_ , **int** _x_ ,
              **const cchar_t ***_wch_ , **int** _n_**);**
           **int mvwhline_set(**
              **WINDOW ***_win_ ,
              **int** _y_ , **int** _x_ ,
              **const cchar_t ***_wch_ , **int** _n_**);**
           **int vline_set(**
              **const cchar_t ***_wch_ , **int** _n_**);**
           **int wvline_set(**
              **WINDOW ***_win_ ,
              **const cchar_t ***_wch_ , **int** _n_**);**
           **int mvvline_set(**
              **int** _y_ , **int** _x_ ,
              **const cchar_t ***_wch_ , **int** _n_**);**
           **int mvwvline_set(**
              **WINDOW ***_win_ ,
              **int** _y_ , **int** _x_ ,
              **const cchar_t ***_wch_ , **int** _n_**);**
    


## DESCRIPTION



           The  **border_set** and **wborder_set** functions draw a border around the
           edges of the current or specified window.  These functions do  not
           change the cursor position, and do not wrap.
    
           Other  than  the window, each argument is a complex character with
           attributes:
                  _ls_ - left side,
                  _rs_ - right side,
                  _ts_ - top side,
                  _bs_ - bottom side,
                  _tl_ - top left-hand corner,
                  _tr_ - top right-hand corner,
                  _bl_ - bottom left-hand corner, and
                  _br_ - bottom right-hand corner.
    
           If any of these arguments is zero, then the corresponding  default
           values (defined in **curses.h**) are used instead:
                  **WACS_VLINE** ,
                  **WACS_VLINE** ,
                  **WACS_HLINE** ,
                  **WACS_HLINE** ,
                  **WACS_ULCORNER** ,
                  **WACS_URCORNER** ,
                  **WACS_LLCORNER** , and
                  **WACS_LRCORNER**.
    
           **box_set(**_win_ , _verch_**,**_horch_**);** is a shorthand for the following call:
    
           **wborder_set(**_win_**,**_verch_**,**_verch_**,**
               _horch_**,**_horch_**, NULL, NULL, NULL, NULL);**
    
           The  ***line_set** functions  use  _wch_ to draw a line starting at the
           current cursor position in the window.  The  line  is  at  most  _n_
           characters  long  or  as many as fit into the window.  The current
           cursor position is not changed.
    
           The **hline_set** , **mvhline_set** , **mvwhline_set** , and **whline_set** functions
           draw a line proceeding toward the last column of the same line.
    
           The **vline_set** , **mvvline_set** , **mvwvline_set** , and **wvline_set** functions
           draw a line proceeding toward the last line of the window.
    


## NOTES



           Note that **border_set** , **hline_set** , **mvhline_set** ,  **mvvline_set** ,  **mvwh‐**
           **line_set** , **mvwvline_set** , and **vline_set** may be macros.
    


## RETURN VALUE



           Upon successful completion, these functions return **OK**.  Otherwise,
           they return **ERR**.
    
           Functions using a window parameter return an error if it is null.
    
           Functions with a “mv” prefix first perform a cursor movement using
           **wmove** ,  and return an error if the position is outside the window,
           or if the window pointer is null.
    


* * *