usr/src/man/man3xcurses/in_wch.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH IN_WCH 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 in_wch, mvin_wch, mvwin_wch, win_wch \- retrieve a complex character (with
   9 rendition)
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  14 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  15
  16 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  17
  18 #include <curses.h>
  19
  20 \fBint\fR \fBin_wch\fR(\fBcchar_t *\fR\fIwcval\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBint\fR \fBmvin_wch\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBcchar_t *\fR\fIwcval\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBint\fR \fBmvwin_wch\fR(\fBWINDOW *\fR\fIwin\fR, \fB\fR\fIinty\fR, \fBcchar_t *\fR\fIwcval\fR);
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBint\fR \fBwin_wch\fR(\fBWINDOW *\fR\fIwin\fR, \fBcchar_t *\fR\fIwcval\fR);
  36 .fi
  37
  38 .SH DESCRIPTION
  39 .sp
  40 .LP
  41 The \fBin_wch()\fR and \fBwin_wch()\fR functions retrieve the complex character
  42 and its rendition located at the current cursor position of the  \fBstdscr\fR
  43 window and window \fIwin\fR, respectively. The \fBmvin_wch()\fR and
  44 \fBmvwin_wch()\fR functions retrieve the complex character and its rendition
  45 located at the position indicated by the \fIx\fR  (column) and \fIy\fR (row)
  46 parameters (the former in the \fBstdscr\fR window; the latter in window
  47 \fIwin\fR).
  48 .sp
  49 .LP
  50 All these functions store the retrieved character and its rendition in the
  51 object pointed to by \fIwcval\fR.
  52 .SH PARAMETERS
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fIwcval\fR\fR
  57 .ad
  58 .RS 9n
  59 Is a pointer to an object that can store a complex character and its rendition.
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fIy\fR\fR
  66 .ad
  67 .RS 9n
  68 Is the y (row) coordinate of the position of the character to be returned.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fIx\fR\fR
  75 .ad
  76 .RS 9n
  77 Is the x (column) coordinate of the position of the character to be returned.
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fIwin\fR\fR
  84 .ad
  85 .RS 9n
  86 Is a pointer to the window that contains the character to be returned.
  87 .RE
  88
  89 .SH RETURN VALUES
  90 .sp
  91 .LP
  92 On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
  93 .SH ERRORS
  94 .sp
  95 .LP
  96 None.
  97 .SH ATTRIBUTES
  98 .sp
  99 .LP
 100 See \fBattributes\fR(5) for descriptions of the following attributes:
 101 .sp
 102
 103 .sp
 104 .TS
 105 box;
 106 c | c
 107 l | l .
 108 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 109 _
 110 Interface Stability     Standard
 111 _
 112 MT-Level        Unsafe
 113 .TE
 114
 115 .SH SEE ALSO
 116 .sp
 117 .LP
 118 \fBadd_wch\fR(3XCURSES), \fBinch\fR(3XCURSES), \fBlibcurses\fR(3XCURSES),
 119 \fBattributes\fR(5), \fBstandards\fR(5)