X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_termcap.3x.html;h=36c4e7acdd9440ca030b81168ebfd76ba72eabe3;hp=e26879ace46cb32f972591cc5c051311c8408bbc;hb=027d0c57c4c4d6690e8d8727888d3282dbe9aa86;hpb=8d00601178f9d92b95a91c93f74547517d93168b diff --git a/doc/html/man/curs_termcap.3x.html b/doc/html/man/curs_termcap.3x.html index e26879ac..36c4e7ac 100644 --- a/doc/html/man/curs_termcap.3x.html +++ b/doc/html/man/curs_termcap.3x.html @@ -1,6 +1,6 @@ @@ -38,8 +38,7 @@ -

curs_termcap 3x

 curs_termcap(3x)                                       curs_termcap(3x)
 
@@ -118,9 +117,23 @@
 
        The tgetstr routine returns the string entry  for  id,  or
        zero  if it is not available.  Use tputs to output the re-
-       turned string.  The return value will also  be  copied  to
-       the  buffer pointed to by area, and the area value will be
-       updated to point past the null ending this value.
+       turned string.  The area parameter is used as follows:
+
+          o   It is assumed to be the address of a pointer  to  a
+              buffer managed by the calling application.
+
+          o   However,  ncurses checks to ensure that area is not
+              NULL, and also that the resulting buffer pointer is
+              not  NULL.  If either check fails, the area parame-
+              ter is ignored.
+
+          o   If the checks succeed, ncurses also copies the  re-
+              turn  value  to  the buffer pointed to by area, and
+              the area value will be updated to  point  past  the
+              null ending this value.
+
+          o   The return value itself is an address in the termi-
+              nal description which is loaded into memory.
 
        Only the first two characters of the id parameter of tget-
        flag, tgetnum and tgetstr are compared in lookups.