insnstr(3curses)

insnstr -- insert a multi-byte character string into a window

Synopsis

cc [options] file -lcurses

#include <curses.h>

int insnstr(const char *str, int n);

int insstr(const char *str);

int mvinsnstr(int y, int x, const char *str, int n);

int mvinsstr(int y, int x, const char *str);

int mvwinsnstr(WINDOW *win, int y, int x, const char *str, int n);

int mvwinsstr(WINDOW *win, int y, int x, const char *str);

int winsnstr(WINDOW *win, const char *str, int n);

int winsstr(WINDOW *win, const char *str);

Description

These functions insert a character string (as many characters as will fit on the line) before the current or specified position in the current or specified window.

These functions do not advance the cursor position. These functions perform special-character processing. The insnstr(3curses) and winsnstr(3curses) functions perform wrapping. The insstr(3curses) and winsstr(3curses) functions do not perform wrapping.

The insnstr(3curses), mvinsnstr(3curses), mvwinsnstr(3curses) and winsnstr(3curses) functions insert at most n bytes. If n is less than 1, the entire string is inserted.

Return value

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

Errors

No errors are defined.

Usage

Since the string may contain multi-byte characters, there might not be a one-to-one correspondence between the number of column positions occupied by the characters and the number of bytes in the string.

Standards Conformance

The Single UNIX Specification, Version 2; The Open Group.

References

curses(4)