Index for Section 3

Alphabetical listing for C

Bottom of page

curs_getcchar(3)
NAME
  curs_getcchar, getcchar, setcchar - Get a wide character string and
  rendition from a cchar_t or set a cchar_t from a wide-character string

SYNOPSIS
  #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 );

LIBRARY
  Curses Library (libcurses)

STANDARDS
  Interfaces documented on this reference page conform to industry standards
  as follows:

  getcchar, setcchar:  XCURSES4.2

  Refer to the standards(5) reference page for more information about
  industry standards and associated tags.

DESCRIPTION
  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:

    ·  Extracts information from a cchar_t type defined for wcval

    ·  Stores the character attributes in the object pointed to by attrs

    ·  Stores the color-pair in the object pointed to by color_pair

    ·  Stores the wide-character string, both spacing and nonspacing
       characters referenced by wcval, into the array pointed to by wch.

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

    ·  Obtains the number of wide characters, both spacing and non-spacing
       characters, in the object pointed to by wcval

    ·  Does not change the objects pointed to by attrs or color_pair

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

    ·  The character attributes in attrs

    ·  The color pair in color_pair

    ·  The wide-character string pointed to by wch

  The wch value should contain either a spacing character, followed by
  nonspacing characters, or just the nonspacing characters.

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

NOTES
  The header file <curses.h> automatically includes the header file
  <stdio.h>.

  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.

RETURN VALUES
  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.

SEE ALSO
  Functions: curses(3), curs_attr_get(3), can_change_color(3)

  Others: standards(5)

Index for Section 3

Alphabetical listing for C

Top of page