***************************************************************************
Copyright (c) 2001-2010,2012 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.16 2012/11/03 23:03:59 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: .bP Extracts information from a cchar_t value wcval .bP Stores the character attributes in the location pointed to by attrs .bP Stores the color-pair in the location pointed to by color_pair .bP 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: .bP Obtains the number of wide characters pointed to by wcval .bP Does not change the data referenced by attrs or color_pair

The setcchar function initializes the location pointed to by wcval by using: .bP The character attributes in attrs .bP The color pair in color_pair .bP The wide-character string pointed to by wch. The string must be L'\\0' terminated, contain at most one spacing character, which must be the first.

Up to CCHARW_MAX-1 nonspacing characters may follow. Additional nonspacing characters are ignored. The string may contain a single control character instead. In that case, no nonspacing characters are allowed.

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 one for a trailing null.

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: curs_attr(3X), curs_color(3X), curses(3X), wcwidth(3).