share/man/man3c/getwidth.3c

   1 '\" te
   2 .\"  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 GETWIDTH 3C "Dec 20, 1996"
   7 .SH NAME
   8 getwidth \- get codeset information
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <euc.h>
  13 #include <getwidth.h>
  14
  15 \fBvoid\fR \fBgetwidth\fR(\fBeucwidth_t *\fR\fIptr\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBgetwidth()\fR function reads the character class table for the current
  22 locale to get information on the supplementary codesets. \fBgetwidth()\fR sets
  23 this information into the struct \fBeucwidth_t\fR. This struct is defined in
  24 <\fBeuc.h\fR> and has the following members:
  25 .sp
  26 .in +2
  27 .nf
  28 short int   _eucw1,_eucw2,_eucw3;
  29 short int   _scrw1,_scrw2,_scrw3;
  30 short int   _pcw;
  31 char        _multibyte;
  32 .fi
  33 .in -2
  34
  35 .sp
  36 .LP
  37 Codeset width values for supplementary codesets 1, 2, and 3 are set in
  38 \fB_eucw1\fR, \fB_eucw2\fR, and \fB_eucw3\fR, respectively. Screen width values
  39 for supplementary codesets 1, 2, and 3 are set in \fB_scrw1\fR, \fB_scrw2\fR,
  40 and \fB_scrw3\fR, respectively.
  41 .sp
  42 .LP
  43 The width of  Extended Unix Code (EUC) Process Code is set in \fB_pcw\fR. The
  44 \fB_multibyte\fR entry is set to \fB1\fR if multibyte characters are used, and
  45 set to \fB0\fR if only single-byte characters are used.
  46 .SH ATTRIBUTES
  47 .sp
  48 .LP
  49 See \fBattributes\fR(5) for descriptions of the following attributes:
  50 .sp
  51
  52 .sp
  53 .TS
  54 box;
  55 c | c
  56 l | l .
  57 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  58 _
  59 MT-Level        MT-Safe with exceptions
  60 .TE
  61
  62 .SH SEE ALSO
  63 .sp
  64 .LP
  65 \fBeuclen\fR(3C), \fBsetlocale\fR(3C), \fBattributes\fR(5)
  66 .SH NOTES
  67 .sp
  68 .LP
  69 The \fBgetwidth()\fR function can be used safely in a multithreaded
  70 application, as long as \fBsetlocale\fR(3C) is not being called to change the
  71 locale.
  72 .sp
  73 .LP
  74 The \fBgetwidth()\fR function will only work with \fBEUC\fR locales.