cursgetcchar(3X) cursgetcchar(3X)

NAME
       ggeettcccchhaarr,  sseettcccchhaarr  - Get a wide character string and rendition from a
       cccchhaarrtt or set a cccchhaarrtt from a wide-character string

SYNOPSIS
       ##iinncclluuddee <>

       iinntt ggeettcccchhaarr((
               ccoonnsstt cccchhaarrtt **wcval,,
               wwcchhaarrtt **wch,,
               aattttrrtt **attrs,,
               sshhoorrtt **colorpair,,
               vvooiidd **opts ));;

       iinntt sseettcccchhaarr((
               cccchhaarrtt **wcval,,
               ccoonnsstt wwcchhaarrtt **wch,,
               ccoonnsstt aattttrrtt attrs,,
               sshhoorrtt colorpair,,
               vvooiidd **opts ));;

DESCRIPTION
       The ggeettcccchhaarr function gets a wide-character string and rendition from a
       cccchhaarrtt  argument.   When wch is not a null pointer, the ggeettcccchhaarr func-
       tion does the following:

       -    Extracts information from a cccchhaarrtt value wcval

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

       -    Stores the color-pair in the location pointed to by colorpair

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

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

       -    Obtains the number of wide characters pointed to by wcval

       -    Does not change the data referenced by attrs or colorpair

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

       -    The character attributes in attrs

       -    The color pair in colorpair

       -    The  wide-character  string pointed to by wch.  The string must be
            L'\0' terminated, contain at most one character with strictly pos-
            itive width, which must be the first, and contain no characters of
            negative width.

NNOOTTEESS
       The opts argument is reserved for future use.  Currently,  an  applica-
       tion must provide a null pointer as opts.

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

RETURN VALUES
       When wch is a null pointer, ggeettcccchhaarr returns the number of wide charac-
       ters referenced by wcval, including the null terminator.

       When wch is not a null pointer, ggeettcccchhaarr  returns  OOKK  upon  successful
       completion, and EERRRR otherwise.

       Upon successful completion, sseettcccchhaarr returns OOKK.  Otherwise, it returns
       EERRRR.

SEE ALSO
       Functions:      ccuurrsseess(3X),       wwccwwiiddtthh(3X),       ccuurrssaattttrrggeett(3X),
       ccaanncchhaannggeeccoolloorr(3X).



                                                             cursgetcchar(3X)