xref: /illumos-gate/usr/src/man/man3xcurses/putp.3xcurses (revision e86372a01d2d16a5dd4a64e144ed978ba17fe7dd)
te
Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
PUTP 3XCURSES "Jun 5, 2002"
NAME
putp, tputs - apply padding information and output string
SYNOPSIS

cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \e
 -R  /usr/xpg4/lib  -lcurses  [ library... ]

c89 [ flag... ] file... -lcurses [ library... ]

#include <curses.h>

int putp(const char *str);

int tputs(const char *str, int affcnt, int (*putfunc) (int));
PARAMETERS
str

Is a pointer to a terminfo variable or return value from tgetstr(3XCURSES), tgoto(3XCURSES), tigetstr(3XCURSES), or tparm(3XCURSES).

affcnt

Is the number of lines affected, or 1 if not relevant.

putfunc

Is the output function.

DESCRIPTION

The putp() and tputs() functions are low-level functions used to deal directly with the terminfo database. The use of appropriate X/Open Curses functions is recommended for most situations.

The tputs() function adds padding information and then outputs str. str must be a terminfo string variable or the result value from tgetstr(), tgoto(), tigetstr(), or tparm(). The tputs() function replaces the padding specification (if one exists) with enough characters to produce the specified delay. Characters are output one at a time to putfunc, a user-specified function similar to putchar(3C).

The putp() function calls tputs() as follows:

tputs(str, 1, putchar)

RETURN VALUES

On success, these functions return OK.

ERRORS

None.

USAGE

The output of putp() goes to stdout, not to the file descriptor, fildes, specified in setupterm(3XCURSES).

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level Unsafe
SEE ALSO

libcurses(3XCURSES), putchar(3C), setupterm(3XCURSES), tgetent(3XCURSES), tigetflag(3XCURSES), terminfo(4), attributes(5), standards(5)