'\" te
.\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
.TH hline_set 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions"
.SH NAME
hline_set, mvhline_set, mvvline_set, mvwhline_set, mvwvline_set, vline_set, whline_set, wvline_set \- use complex characters (and renditions) to draw lines
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]

\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]

#include <curses.h>

\fBint\fR \fBhline_set\fR(\fBconst cchar_t *\fR\fIch\fR, \fBint\fR \fIn\fR);
.fi

.LP
.nf
\fBint\fR \fBmvhline_set\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwch\fR, \fBint\fR \fIn\fR);
.fi

.LP
.nf
\fBint\fR \fBmvvline_set\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwch\fR, \fBint\fR \fIn\fR);
.fi

.LP
.nf
\fBint\fR \fBmvwhline_set\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwch\fR, \fBint\fR \fIn\fR);
.fi

.LP
.nf
\fBint\fR \fBmvwvline_set\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwch\fR, \fBint\fR \fIn\fR);
.fi

.LP
.nf
\fBint\fR \fBvline_set\fR(\fBconst cchar_t *\fR\fIwch\fR, \fBint\fR \fIn\fR);
.fi

.LP
.nf
\fBint\fR \fBwhline_set\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst cchar_t *\fR\fIwch\fR, \fBint\fR \fIn\fR);
.fi

.LP
.nf
\fBint\fR \fBwvline_set\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst cchar_t *\fR\fIwch\fR, \fBint\fR \fIn\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBhline_set()\fR, \fBvline_set()\fR, \fBwhline_set()\fR,  \fBwvline_set()\fR functions draw a line, in either the window \fBstdscr\fR  or \fIwin\fR  starting at the current cursor position. The line is drawn using the character \fIwch\fR and is a maximum of \fIn\fR positions long, or as many as will fit into the window.  If \fIwch\fR is a null pointer, the default horizontal or vertical character is used.
.sp
.LP
The \fBmvhline_set()\fR, \fBmvvline_set()\fR, \fBmvwhline_set()\fR,  \fBmvwvline_set()\fR functions are similar to the previous group of functions  but the line begins at cursor position specified by \fIx\fR and \fIy\fR.
.sp
.LP
The functions with names ending with \fBhline_set()\fR draw horizontal lines proceeding towards the last column of the same line. The functions with names ending with \fBvline_set()\fR draw vertical lines proceeding towards the last column of the same line.
.sp
.LP
These functions do not change the position of the cursor.
.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIwch\fR\fR
.ad
.RS 7n
.rt  
Is the complex character used to draw the line.
.RE

.sp
.ne 2
.mk
.na
\fB\fIn\fR\fR
.ad
.RS 7n
.rt  
Is the maximum number of characters in the line.
.RE

.sp
.ne 2
.mk
.na
\fB\fIy\fR\fR
.ad
.RS 7n
.rt  
Is the y (row) coordinate for the start of the line.
.RE

.sp
.ne 2
.mk
.na
\fB\fIx\fR\fR
.ad
.RS 7n
.rt  
Is the x (column) coordinate for the start of the line.
.RE

.sp
.ne 2
.mk
.na
\fB\fIwin\fR\fR
.ad
.RS 7n
.rt  
Is a pointer to a window.
.RE

.SH RETURN VALUES
.sp
.LP
On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
.SH ERRORS
.sp
.LP
None.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelUnsafe
_
StandardSee \fBstandards\fR(5).
.TE

.SH SEE ALSO
.sp
.LP
\fBborder\fR(3XCURSES), \fBborder_set\fR(3XCURSES), \fBhline\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)