usr/src/man/man9f/kiconv_close.9f

   1 '\" te
   2 .\" Copyright (c) 2007, 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 KICONV_CLOSE 9F "Oct 16, 2007"
   7 .SH NAME
   8 kiconv_close \- code conversion descriptor deallocation function
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/errno.h>
  13 #include <sys/sunddi.h>
  14
  15
  16
  17 \fBint\fR \fBkiconv_close\fR(\fBkiconv_t\fR \fIcd\fR);
  18 .fi
  19
  20 .SH INTERFACE LEVEL
  21 .sp
  22 .LP
  23 Solaris DDI specific (Solaris DDI).
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIcd\fR\fR
  29 .ad
  30 .RS 6n
  31 Code conversion descriptor to be deallocated.
  32 .RE
  33
  34 .SH DESCRIPTION
  35 .sp
  36 .LP
  37 The \fBkiconv_close()\fR function deallocates the conversion descriptor
  38 \fIcd\fR and all other associated resources allocated by the
  39 \fBkiconv_open()\fR function.
  40 .SH RETURN VALUES
  41 .sp
  42 .LP
  43 Upon successful completion, \fBkiconv_close()\fR returns 0; otherwise, it
  44 returns the following \fIerrno\fR value to indicate the error:
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fBEBADF\fR\fR
  49 .ad
  50 .RS 9n
  51 The code conversion descriptor is invalid.
  52 .RE
  53
  54 .SH CONTEXT
  55 .sp
  56 .LP
  57 \fBkiconv_close()\fR can be called from user or interrupt context.
  58 .SH EXAMPLES
  59 .LP
  60 \fBExample 1 \fRClosing the Code Conversion
  61 .sp
  62 .LP
  63 The following example shows how to close the code conversion descriptor with
  64 error checking:
  65
  66 .sp
  67 .in +2
  68 .nf
  69 if (kiconv_close(cd) == EBADF) {
  70          /* Code conversion descriptor is invalid. */
  71          return (-1);
  72 }
  73 .fi
  74 .in -2
  75
  76 .sp
  77 .LP
  78 The following example shows how to close the code conversion descriptor without
  79 error checking:
  80
  81 .sp
  82 .in +2
  83 .nf
  84 (void) kiconv_close(cd);
  85 .fi
  86 .in -2
  87
  88 .SH ATTRIBUTES
  89 .sp
  90 .LP
  91 See \fBattributes\fR(5) for descriptions of the following attributes:
  92 .sp
  93
  94 .sp
  95 .TS
  96 box;
  97 c | c
  98 l | l .
  99 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 100 _
 101 Interface Stability     Committed
 102 .TE
 103
 104 .SH SEE ALSO
 105 .sp
 106 .LP
 107 \fBiconv\fR(3C), \fBiconv_close\fR(3C), \fBiconv_open\fR(3C),
 108 \fBu8_strcmp\fR(3C), \fBu8_textprep_str\fR(3C), \fBu8_validate\fR(3C),
 109 \fBuconv_u16tou32\fR(3C), \fBuconv_u16tou8\fR(3C), \fBuconv_u32tou16\fR(3C),
 110 \fBuconv_u32tou8\fR(3C), \fBuconv_u8tou16\fR(3C), \fBuconv_u8tou32\fR(3C),
 111 \fBattributes\fR(5), \fBkiconv\fR(9F), \fBkiconvstr\fR(9F),
 112 \fBkiconv_open\fR(9F), \fBu8_strcmp\fR(9F), \fBu8_textprep_str\fR(9F),
 113 \fBu8_validate\fR(9F), \fBuconv_u16tou32\fR(9F), \fBuconv_u16tou8\fR(9F),
 114 \fBuconv_u32tou16\fR(9F), \fBuconv_u32tou8\fR(9F), \fBuconv_u8tou16\fR(9F),
 115 \fBuconv_u8tou32\fR(9F)
 116 .sp
 117 .LP
 118 The Unicode Standard
 119 .sp
 120 .LP
 121 http://www.unicode.org/standard/standard.html