xref: /illumos-gate/usr/src/man/man9f/kiconv_close.9f (revision dd72704bd9e794056c558153663c739e2012d721)
te
Copyright (c) 2007, Sun Microsystems, Inc., All Rights Reserved
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.
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.
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]
KICONV_CLOSE 9F "Oct 16, 2007"
NAME
kiconv_close - code conversion descriptor deallocation function
SYNOPSIS
#include <sys/errno.h>
#include <sys/sunddi.h>



int kiconv_close(kiconv_t cd);
INTERFACE LEVEL
illumos DDI specific (illumos DDI).
PARAMETERS
cd

Code conversion descriptor to be deallocated.

DESCRIPTION
The kiconv_close() function deallocates the conversion descriptor cd and all other associated resources allocated by the kiconv_open() function.
RETURN VALUES
Upon successful completion, kiconv_close() returns 0; otherwise, it returns the following errno value to indicate the error: EBADF

The code conversion descriptor is invalid.

CONTEXT
kiconv_close() can be called from user or interrupt context.
EXAMPLES
Example 1 Closing the Code Conversion

The following example shows how to close the code conversion descriptor with error checking:

if (kiconv_close(cd) == EBADF) {
 /* Code conversion descriptor is invalid. */
 return (-1);
}

The following example shows how to close the code conversion descriptor without error checking:

(void) kiconv_close(cd);
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
SEE ALSO
iconv (3C), iconv_close (3C), iconv_open (3C), u8_strcmp (3C), u8_textprep_str (3C), u8_validate (3C), uconv_u16tou32 (3C), uconv_u16tou8 (3C), uconv_u32tou16 (3C), uconv_u32tou8 (3C), uconv_u8tou16 (3C), uconv_u8tou32 (3C), attributes (7), kiconv (9F), kiconv_open (9F), kiconvstr (9F), u8_strcmp (9F), u8_textprep_str (9F), u8_validate (9F), uconv_u16tou32 (9F), uconv_u16tou8 (9F), uconv_u32tou16 (9F), uconv_u32tou8 (9F), uconv_u8tou16 (9F), uconv_u8tou32 (9F)

The Unicode Standard

http://www.unicode.org/standard/standard.html