X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_insstr.3x.html;h=285bfa4bcfa18669402f92bd14ec146f093d01f5;hp=4a43951510852f9390557086965392e309262a2b;hb=HEAD;hpb=f70db18a0c3c6a828d8a5999be37239f01c9d98a diff --git a/doc/html/man/curs_insstr.3x.html b/doc/html/man/curs_insstr.3x.html index 4a439515..693f6f76 100644 --- a/doc/html/man/curs_insstr.3x.html +++ b/doc/html/man/curs_insstr.3x.html @@ -1,7 +1,7 @@ - - + -curs_insstr 3x - - + + +curs_insstr 3x 2024-04-20 ncurses 6.4 Library calls + + -

curs_insstr 3x

-
+

curs_insstr 3x 2024-04-20 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
+

NAME

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

SYNOPSIS

+

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 charac-
-       ters 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  char-
-       acters  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.
 
-       Special characters are handled as in addch.
+

DESCRIPTION

+       These routines insert a character string (as many  characters  as  will
+       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).
 
-
-

RETURN VALUE

-       All  routines that return an integer return ERR upon fail-
-       ure and OK (SVr4 specifies only "an  integer  value  other
-       than  ERR")  upon  successful completion, unless otherwise
-       noted in the preceding routine descriptions.
+       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).
 
-       X/Open defines no error conditions.  In  this  implementa-
-       tion, if the window parameter is null or the str parameter
-       is null, an error is returned.
+       Special characters are handled as in waddch(3x).
 
 
-
-

NOTES

-       Note that all but winsnstr may be macros.
+

RETURN VALUE

+       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
 
-
-

PORTABILITY

-       These functions are described in the XSI Curses  standard,
-       Issue 4, which adds const qualifiers to the arguments.
+       o   if the win parameter is null or
 
-       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 inconsis-
-       tent.  Also, no implementation of  curses  documents  this
-       inconsistency.
+       o   if the str parameter is null or
 
+       o   the winsch(3x) function returns an error.
 
-
-

SEE ALSO

-       curses(3x),  curs_util(3x), curs_clear(3x), curs_inch(3x).
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x) is outside the window boundaries.
+
+
+

NOTES

+       All but winsnstr may be macros.
+
+
+

PORTABILITY

+       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_inch(3x), curs_ins_wstr(3x), curs_util(3x)
 
 
 
-                                                        curs_insstr(3x)
+ncurses 6.4                       2024-04-20                   curs_insstr(3x)
-
-
-Man(1) output converted with -man2html -
+
+ +