X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_getcchar.3x;h=8085c952fca9e8a05ac277cfe7a58d257e225a16;hp=91b996197c58bb448920a6330ffb07a0e1196436;hb=71c0306f0824ef2b10c4c5813fb003db48f3012e;hpb=027ae42953e3186daed8f3882da73de48291b606;ds=sidebyside diff --git a/man/curs_getcchar.3x b/man/curs_getcchar.3x index 91b99619..8085c952 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-2009,2010 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,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_getcchar.3x,v 1.8 2006/07/15 22:51:07 wcmbrine Exp $ +.\" $Id: curs_getcchar.3x,v 1.13 2010/07/31 16:12:01 tom Exp $ .TH curs_getcchar 3X "" .SH NAME \fBgetcchar\fP, @@ -64,16 +64,16 @@ 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 -- +\- Extracts information from a \fBcchar_t\fP value \fIwcval\fP .TP 5 -- +\- Stores the character attributes in the location pointed to by \fIattrs\fP .TP 5 -- +\- Stores the color-pair in the location pointed to by \fIcolor_pair\fP .TP 5 -- +\- Stores the wide-character string, characters referenced by \fIwcval\fP, into the array pointed to by \fIwch\fP. .PP @@ -83,10 +83,10 @@ is a null pointer, the \fBgetcchar\fP function does the following: .TP 5 -- +\- Obtains the number of wide characters pointed to by \fIwcval\fP .TP 5 -- +\- Does not change the data referenced by \fIattrs\fP or @@ -95,20 +95,25 @@ or The \fBsetcchar\fP function initializes the location pointed to by \fIwcval\fP by using: .TP 5 -- +\- The character attributes in \fIattrs\fP .TP 5 -- +\- The color pair in \fIcolor_pair\fP .TP 5 -- +\- 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. @@ -121,7 +126,8 @@ If \fIwcval\fP is constructed by any other means, the effect is unspecified. .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, @@ -132,10 +138,10 @@ Otherwise, it returns \fBERR\fP. .SH SEE ALSO .PP Functions: +\fBcurs_attr\fR(3X), +\fBcurs_color\fR(3X), \fBcurses\fR(3X), -\fBwcwidth\fR(3X), -\fBcurs_attr_get\fR(3X), -\fBcan_change_color\fR(3X). +\fBwcwidth\fR(3). .\"# .\"# The following sets edit modes for GNU EMACS .\"# Local Variables: