getcchar man page on SunOS

Man page or keyword search:  
man Server   20652 pages
apropos Keyword Search (all sections)
Output format
SunOS logo
[printable version]

getcchar(3XCURSES)	X/Open Curses Library Functions	    getcchar(3XCURSES)

NAME
       getcchar - get a wide character string (with rendition) from a cchar_t

SYNOPSIS
       cc [ flag... ] file... -I /usr/xpg4/include -L /usr/xpg4/lib \
       -R /usr/xpg4/lib -lcurses [ library... ]

       c89 [ flag... ] file... -lcurses [ library... ]

       #include <curses.h>

       int  getcchar(const  cchar_t *wcval, wchar_t *wch, attr_t *attrs, short
       *color_pair, void *opt);

DESCRIPTION
       If wch is not a	null  pointer,	the  getcchar()	 function  splits  the
       cchar_t	object	pointed	 to  by	 wcval	into  a wide character string,
       attributes, and a color pair. It stores the attributes in the  location
       pointed	to  by	attrs,	the  color  pair in the location pointed to by
       color_pair, and the wide character string in the location pointed to by
       wch.

       If  wch	is a null pointer, the getcchar() function simply returns  the
       number of wide characters in the cchar_t object pointed to  by	wcval.
       The objects pointed to by attrs and color_pair are not changed.

PARAMETERS
       wcval	       Is a pointer to a cchar_t object.

       wch	       Is a pointer to an object where a wide character string
		       can be stored.

       attrs	       Is a pointer to	an  object  where  attributes  can  be
		       stored.

       color_pair      Is  a  pointer  to  an object where a color pair can be
		       stored.

       opts	       Is reserved for future use. Currently, this must	 be  a
		       null pointer.

RETURN VALUES
       When wch is a null pointer, the getcchar() function returns the	number
       of wide characters in the string pointed to  by	wcval  including   the
       null terminator.

       When wch is not a null pointer, the getcchar() function	returns	 OK on
       success and ERR otherwise.

ERRORS
       None

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       ┌─────────────────────────────┬─────────────────────────────┐
       │      ATTRIBUTE TYPE	     │	    ATTRIBUTE VALUE	   │
       ├─────────────────────────────┼─────────────────────────────┤
       │Interface Stability	     │Standard			   │
       ├─────────────────────────────┼─────────────────────────────┤
       │MT-Level		     │Unsafe			   │
       └─────────────────────────────┴─────────────────────────────┘

SEE ALSO
       attroff(3XCURSES),   can_change_color(3XCURSES),	  libcurses(3XCURSES),
       setcchar(3XCURSES), attributes(5), standards(5)

SunOS 5.10			  5 Jun 2002		    getcchar(3XCURSES)
[top]

List of man pages available for SunOS

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net