X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_getcchar.3x;h=4c5b2291187373df3bed69229e3a1883b3ba4303;hp=b811a37db8f724f8ecca7b6b66e5039eba0419db;hb=6a530b46563470c2ca73579d1994a0c8e275dd98;hpb=f70db18a0c3c6a828d8a5999be37239f01c9d98a diff --git a/man/curs_getcchar.3x b/man/curs_getcchar.3x index b811a37d..4c5b2291 100644 --- a/man/curs_getcchar.3x +++ b/man/curs_getcchar.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2001-2003,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 2001-2012,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -26,8 +26,11 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_getcchar.3x,v 1.10 2006/12/24 16:00:02 tom Exp $ +.\" $Id: curs_getcchar.3x,v 1.17 2015/07/21 09:30:38 tom Exp $ .TH curs_getcchar 3X "" +.de bP +.IP \(bu 4 +.. .SH NAME \fBgetcchar\fP, \fBsetcchar\fP \- Get a wide character string and rendition from a \fBcchar_t\fP or set a \fBcchar_t\fP from a wide-character string @@ -58,22 +61,19 @@ .br .B " void *\fIopts\fP );" .SH DESCRIPTION +.SS getcchar .PP The \fBgetcchar\fP function gets a wide-character string and rendition from a \fBcchar_t\fP argument. When \fIwch\fP is not a null pointer, the \fBgetcchar\fP function does the following: -.TP 5 -- +.bP Extracts information from a \fBcchar_t\fP value \fIwcval\fP -.TP 5 -- +.bP Stores the character attributes in the location pointed to by \fIattrs\fP -.TP 5 -- +.bP Stores the color-pair in the location pointed to by \fIcolor_pair\fP -.TP 5 -- +.bP Stores the wide-character string, characters referenced by \fIwcval\fP, into the array pointed to by \fIwch\fP. .PP @@ -82,33 +82,34 @@ When is a null pointer, the \fBgetcchar\fP function does the following: -.TP 5 -- +.bP Obtains the number of wide characters pointed to by \fIwcval\fP -.TP 5 -- +.bP Does not change the data referenced by \fIattrs\fP or \fIcolor_pair\fP +.SS setcchar .PP The \fBsetcchar\fP function initializes the location pointed to by \fIwcval\fP by using: -.TP 5 -- +.bP The character attributes in \fIattrs\fP -.TP 5 -- +.bP The color pair in \fIcolor_pair\fP -.TP 5 -- +.bP The wide-character string pointed to by \fIwch\fP. The string must be L'\\0' terminated, -contain at most one character with strictly positive width, -which must be the first, -and contain no characters of negative width. +contain at most one spacing character, +which must be the first. +.IP +Up to \fBCCHARW_MAX\fP\-1 nonspacing characters may follow. +Additional nonspacing characters are ignored. +.IP +The string may contain a single control character instead. +In that case, no nonspacing characters are allowed. .SH NOTES .PP The \fIopts\fP argument is reserved for future use. @@ -117,11 +118,12 @@ Currently, an application must provide a null pointer as \fIopts\fP. The \fIwcval\fP argument may be a value generated by a call to \fBsetcchar\fP or by a function that has a \fBcchar_t\fP output argument. If \fIwcval\fP is constructed by any other means, the effect is unspecified. -.SH RETURN VALUES +.SH RETURN VALUE .PP When \fIwch\fP is a null pointer, \fBgetcchar\fP returns the number of wide characters referenced by -\fIwcval\fP. +\fIwcval\fP, +including one for a trailing null. .PP When \fIwch\fP is not a null pointer, \fBgetcchar\fP returns \fBOK\fP upon successful completion, @@ -136,9 +138,3 @@ Functions: \fBcurs_color\fR(3X), \fBcurses\fR(3X), \fBwcwidth\fR(3). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: