X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_insstr.3x.html;h=1a763d28eddaef4486cc238e1b969aec673c9365;hp=529a81808280ba5be1157f56e0cc061fdbdcc0b3;hb=HEAD;hpb=f79c210479470378389aab5b8d4d42d4a7f3d9a4 diff --git a/doc/html/man/curs_insstr.3x.html b/doc/html/man/curs_insstr.3x.html index 529a8180..04e02399 100644 --- a/doc/html/man/curs_insstr.3x.html +++ b/doc/html/man/curs_insstr.3x.html @@ -1,6 +1,6 @@ -curs_insstr 3x 2022-02-12 ncurses 6.4 Library calls +curs_insstr 3x 2024-04-20 ncurses 6.5 Library calls -

curs_insstr 3x 2022-02-12 ncurses 6.4 Library calls

+

curs_insstr 3x 2024-04-20 ncurses 6.5 Library calls

 curs_insstr(3x)                  Library calls                 curs_insstr(3x)
 
@@ -48,7 +48,7 @@
 
 

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

@@ -66,51 +66,62 @@
 
 

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.
 
-       Special characters are handled as in addch.
+       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 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
-       descriptions.
+       All functions return the integer ERR upon failure and OK on success.
+
+       X/Open   Curses   does   not   specify   any  error  conditions.   This
+       implementation returns an error
 
-       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.
+       o   if the win parameter is null or
 
-       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 str parameter is null or
+
+       o   the winsch(3x) function returns an error.
+
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x) is outside the window boundaries.
 
 
 

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 X/Open Curses, 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.
 
+       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.
+
 
 

SEE ALSO

-       curses(3x), curs_util(3x), curs_clear(3x), curs_inch(3x).
+       curses(3x), curs_inch(3x), curs_ins_wstr(3x), curs_util(3x)
 
 
 
-ncurses 6.4                       2022-02-12                   curs_insstr(3x)
+ncurses 6.5                       2024-04-20                   curs_insstr(3x)