***************************************************************************
Copyright (c) 2001,2002 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 *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************

$Id: curs_getcchar.3x,v 1.6 2002/03/24 01:08:55 tom Exp $
getcchar, setcchar - Get a wide character string and rendition from a cchar_t or set a cchar_t from a wide-character string #include <curses.h> int getcchar(

" const cchar_t *wcval,"

" wchar_t *wch,"

" attr_t *attrs,"

" short *color_pair,"

" void *opts );" "int setcchar("

" cchar_t *wcval,"

" const wchar_t *wch,"

" const attr_t attrs,"

" short color_pair,"

" void *opts );"

The getcchar function gets a wide-character string and rendition from a cchar_t argument. When wch is not a null pointer, the getcchar function does the following:

5 - Extracts information from a cchar_t value wcval

5 - Stores the character attributes in the location pointed to by attrs

5 - Stores the color-pair in the location pointed to by color_pair

5 - Stores the wide-character string, characters referenced by wcval, into the array pointed to by wch.

When wch is a null pointer, the getcchar function does the following:

5 - Obtains the number of wide characters pointed to by wcval

5 - Does not change the data referenced by attrs or color_pair

The setcchar function initializes the location pointed to by wcval by using:

5 - The character attributes in attrs

5 - The color pair in color_pair

5 - The wide-character string pointed to by wch. 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.

The opts argument is reserved for future use. Currently, an application must provide a null pointer as opts.

The wcval argument may be a value generated by a call to setcchar or by a function that has a cchar_t output argument. If wcval is constructed by any other means, the effect is unspecified.

When wch is a null pointer, getcchar returns the number of wide characters referenced by wcval, including the null terminator.

When wch is not a null pointer, getcchar returns OK upon successful completion, and ERR otherwise.

Upon successful completion, setcchar returns OK. Otherwise, it returns ERR.

Functions: curses(3X), wcwidth(3X), curs_attr_get(3X), can_change_color(3X). #
# The following sets edit modes for GNU EMACS
# Local Variables:
# mode:nroff
# fill-column:79
# End: