X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_insstr.3x.html;h=b92975ae40d7a20f6669a09361edeb9e3a2a5471;hb=bd2d9c5734d2c66abe0b2ddd766695b200c154fe;hp=e8b0d9eadb6b65ce2b5a727d9de4667e1e070747;hpb=d97989d1e0db7282c723cabb44b991b951790006;p=ncurses.git diff --git a/doc/html/man/curs_insstr.3x.html b/doc/html/man/curs_insstr.3x.html index e8b0d9ea..b92975ae 100644 --- a/doc/html/man/curs_insstr.3x.html +++ b/doc/html/man/curs_insstr.3x.html @@ -1,6 +1,7 @@ - -curs_insstr 3x +curs_insstr 3x 2023-11-25 ncurses 6.4 Library calls - + -

curs_insstr 3x

curs_insstr 3x 2023-11-25 ncurses 6.4 Library calls

-curs_insstr(3x)                                                curs_insstr(3x)
+curs_insstr(3x)                  Library calls                 curs_insstr(3x)

NAME

        insstr,  insnstr,  winsstr,  winsnstr,  mvinsstr, mvinsnstr, mvwinsstr,
-       mvwinsnstr - insert string before cursor in a curses window
+       mvwinsnstr - insert a string in a curses window

SYNOPSIS

        #include <curses.h>
-       int insstr(const char *str);
-       int insnstr(const char *str, int n);
-       int winsstr(WINDOW *win, const char *str);
-       int winsnstr(WINDOW *win, const char *str, int n);
-       int mvinsstr(int y, int x, const char *str);
-       int mvinsnstr(int y, int x, const char *str, int n);
-       int mvwinsstr(WINDOW *win, int y, int x, const char *str);
-       int mvwinsnstr(WINDOW *win, int y, int x, const char *str, int n);
+       int insstr(const char *str);
+       int insnstr(const char *str, int n);
+       int winsstr(WINDOW *win, const char *str);
+       int winsnstr(WINDOW *win, const char *str, int n);
+
+       int mvinsstr(int y, int x, const char *str);
+       int mvinsnstr(int y, int x, const char *str, int n);
+       int mvwinsstr(WINDOW *win, int y, int x, const char *str);
+       int mvwinsnstr(WINDOW *win, int y, int x, const char *str, int n);

DESCRIPTION

        These routines insert a character string (as many  characters  as  will
-       fit on the line) before the character under the cursor.  All characters
-       to the right of the cursor are shifted right with  the  possibility  of
-       the  rightmost  characters on the line being lost.  The cursor position
-       does not change (after moving to y, x, if  specified).   The  functions
-       with  n  as  the  last argument insert a leading substring of at most n
-       characters.  If n<=0, then the entire string is inserted.
+       fit  on  the line) before the character under the cursor, as if calling
+       winsch(3x).  All characters to the right  of  the  cursor  are  shifted
+       right,  with  the  possibility  of the rightmost characters on the line
+       being lost.  No wrapping is performed.
+
+       The cursor  position  does  not  change  (after  moving  to  y,  x,  if
+       specified).
+
+       The functions with n as the last argument insert a leading substring of
+       at most n characters.  If n is less than zero,  the  entire  string  is
+       inserted (stopping on a NUL character).
 
-       Special characters are handled as in addch.
+       Special characters are handled as in waddch(3x).

RETURN VALUE

-       All routines that return an integer return  ERR  upon  failure  and  OK
-       (SVr4 specifies only "an integer value other than ERR") upon successful
-       completion, unless otherwise noted in the  preceding  routine  descrip-
-       tions.
+       All functions return the integer ERR upon failure and OK on success.
 
-       X/Open  defines  no  error  conditions.  In this implementation, if the
-       window parameter is null or the str parameter  is  null,  an  error  is
-       returned.
+       X/Open  does  not  define  any  error  conditions.  This implementation
+       returns an error
 
-       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.
+       o   if the win parameter is null or
+
+       o   if the str parameter is null or
+
+       o   the winsch(3x) function returns an error.
+
+       Functions with a "mv" prefix first  perform  a  cursor  movement  using
+       wmove(3x),  and  return an error if the position is outside the window,
+       or if the window pointer is null.

NOTES

-       Note that all but winsnstr may be macros.
+       All but winsnstr may be macros.

PORTABILITY

-       These  functions  are  described  in  the XSI Curses standard, Issue 4,
-       which adds const qualifiers to the arguments.
+       These functions are described in the  XSI  Curses  standard,  Issue  4,
+       which adds const qualifiers to the arguments.
+
+       The  Single  Unix  Specification,  Version  2  states  that insnstr and
+       winsnstr perform wrapping.  This is probably an error, since  it  makes
+       this  group  of  functions  inconsistent.   Also,  no implementation of
+       curses documents this inconsistency.
 
-       The Single Unix Specification, Version 2 states that insnstr  and  win-
-       snstr perform wrapping.  This is probably an error, since it makes this
-       group of functions inconsistent.  Also,  no  implementation  of  curses
-       documents this inconsistency.
+       X/Open states that the entire string is inserted if n is less  than  1.
+       This  is  probably  an  error,  because  it  is inconsistent with other
+       functions, and differs from the  SVr4  and  X/Open  implementations  on
+       Solaris.