usr/src/man/man3c/euclen.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 EUCLEN 3C "Dec 20, 1996"
   7 .SH NAME
   8 euclen, euccol, eucscol \- get byte length and display width of EUC characters
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <euc.h>
  13
  14 \fBint\fR \fBeuclen\fR(\fBconst unsigned char *\fR\fIs\fR);
  15 .fi
  16
  17 .LP
  18 .nf
  19 \fBint\fR \fBeuccol\fR(\fBconst unsigned char *\fR\fIs\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fBeucscol\fR(\fBconst unsigned char *\fR\fIstr\fR);
  25 .fi
  26
  27 .SH DESCRIPTION
  28 .sp
  29 .LP
  30 The \fBeuclen()\fR function returns the length in bytes of the Extended Unix
  31 Code (EUC) character pointed to by \fIs\fR, including single-shift characters,
  32 if present.
  33 .sp
  34 .LP
  35 The \fBeuccol()\fR function returns the screen column width of the \fBEUC\fR
  36 character pointed to by \fIs\fR.
  37 .sp
  38 .LP
  39 The \fBeucscol()\fR function returns the screen column width of the \fBEUC\fR
  40 string pointed to by \fIstr\fR.
  41 .sp
  42 .LP
  43 For the \fBeuclen()\fR and \fBeuccol()\fR, functions, \fIs\fR points to the
  44 first byte of the character. This byte is examined to determine its codeset.
  45 The character type table for the current \fIlocale\fR is used for codeset byte
  46 length and display width information.
  47 .SH USAGE
  48 .sp
  49 .LP
  50 These functions will work only with \fBEUC\fR locales.
  51 .sp
  52 .LP
  53 These functions can be used safely in multithreaded applications, as long as
  54 \fBsetlocale\fR(3C) is not called to change the locale.
  55 .SH ATTRIBUTES
  56 .sp
  57 .LP
  58 See \fBattributes\fR(5) for descriptions of the following attributes:
  59 .sp
  60
  61 .sp
  62 .TS
  63 box;
  64 c | c
  65 l | l .
  66 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  67 _
  68 MT-Level        MT-Safe with exceptions
  69 .TE
  70
  71 .SH SEE ALSO
  72 .sp
  73 .LP
  74 \fBgetwidth\fR(3C), \fBsetlocale\fR(3C), \fBattributes\fR(5)