HPlogo HP-UX Reference Volume 4 of 5 > b

box(3X)

CURSES
» 

Technical documentation

Complete book in PDF

 » Table of Contents

 » Index

NAME

box — draw borders from single-byte characters and renditions

SYNOPSIS

#include <curses.h>

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

DESCRIPTION

The box() 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() returns OK. Otherwise, it returns 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(3X), box_set(3X), hline(3X), <curses.h>.

CHANGE HISTORY

First released in X/Open Curses, Issue 2.

X/Open Curses, Issue 4

The DESCRIPTION is changed to describe this function in terms of a call to the wborder() function.

© Hewlett-Packard Development Company, L.P.