X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_getcchar.3x;h=01fc5f673c98ef033208591d1aa779ab872652af;hp=4c5b2291187373df3bed69229e3a1883b3ba4303;hb=b025434573f466efe27862656a6a9d41dd2bd609;hpb=6a530b46563470c2ca73579d1994a0c8e275dd98 diff --git a/man/curs_getcchar.3x b/man/curs_getcchar.3x index 4c5b2291..01fc5f67 100644 --- a/man/curs_getcchar.3x +++ b/man/curs_getcchar.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2001-2012,2015 Free Software Foundation, Inc. * +.\" Copyright (c) 2001-2017,2019 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,10 +26,11 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_getcchar.3x,v 1.17 2015/07/21 09:30:38 tom Exp $ +.\" $Id: curs_getcchar.3x,v 1.21 2019/03/24 00:59:45 tom Exp $ .TH curs_getcchar 3X "" .de bP -.IP \(bu 4 +.ie n .IP \(bu 4 +.el .IP \(bu 2 .. .SH NAME \fBgetcchar\fP, @@ -59,7 +60,7 @@ .br .B " short \fIcolor_pair\fP," .br -.B " void *\fIopts\fP );" +.B " const void *\fIopts\fP );" .SH DESCRIPTION .SS getcchar .PP @@ -110,10 +111,23 @@ 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 +.SH EXTENSIONS .PP -The \fIopts\fP argument is reserved for future use. -Currently, an application must provide a null pointer as \fIopts\fP. +X/Open Curses documents the \fIopts\fP argument as reserved for future use, +saying that it must be null. +This implementation +uses that parameter in ABI 6 for the functions which have a color-pair +parameter to support extended color pairs: +.bP +For functions which modify the color, e.g., \fBsetcchar\fP, +if \fIopts\fP is set it is treated as a pointer to \fBint\fP, +and used to set the color pair instead of the \fBshort\fP pair parameter. +.bP +For functions which retrieve the color, e.g., \fBgetcchar\fP, +if \fIopts\fP is set it is treated as a pointer to \fBint\fP, +and used to retrieve the color pair as an \fBint\fP value, +in addition retrieving it via the standard pointer to \fBshort\fP parameter. +.SH NOTES .PP 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.