X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_getcchar.3x;h=4c5b2291187373df3bed69229e3a1883b3ba4303;hp=8085c952fca9e8a05ac277cfe7a58d257e225a16;hb=092f1e4b79bca1d1cd3e24baa7abc3ad4cea8420;hpb=71c0306f0824ef2b10c4c5813fb003db48f3012e diff --git a/man/curs_getcchar.3x b/man/curs_getcchar.3x index 8085c952..4c5b2291 100644 --- a/man/curs_getcchar.3x +++ b/man/curs_getcchar.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2001-2009,2010 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.13 2010/07/31 16:12:01 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,28 +82,24 @@ 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 spacing character, @@ -122,7 +118,7 @@ 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 @@ -142,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: