Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

idn_setlocalcheckfile (3)

Name

idn_setlocalcheckfile - read local code point set from a file

Synopsis

#include <idn/api.h>

idn_result_t
idn_setlocalcheckfile(const char *file);

Description

idn_setlocalcheckfile(3)   Library Functions Manual   idn_setlocalcheckfile(3)



NAME
       idn_setlocalcheckfile - read local code point set from a file

SYNOPSIS
       #include <idn/api.h>

       idn_result_t
       idn_setlocalcheckfile(const char *file);


DESCRIPTION
       The  function  idn_setlocalcheckfile()  reads local code point set from
       file.  Upon success, it returns idn_success.  Otherwise, it returns  an
       error  code.  See idn_result_tostring(3) for the complete list of error
       codes.

       The local code point set file is a  simple  text  file,  consisting  of
       lines  (other  than  comment  lines,  which begin with ``#'', and empty
       lines) of the form:

           code-point

       or

           start-code-point..end-code-point

       where code-point, start-code-point and end-code-point  are  hexadecimal
       Unicode code point values.  Here is an example:

           002E
           0030..0039
           0061..007A

       Setting the local code point set by calling idn_setlocalcheckfile(), an
       optional "local check" will be performed in encoding and decoding  con-
       versions if IDN_LOCALCHECK action is designated.

       The  local  check  searches an internationalized domain name to be con-
       verted for a code point not listed in the code point file.   If  found,
       the   encoding   or   decoding   function   returns   an   error   code
       idn_localcheck_error.

       Specifying file argument to NULL, the local code point set is  cleared.
       In an encoding or decoding conversion, no code point check is performed
       even when IDN_LOCALCHECK action is designated.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------------------+
       |ATTRIBUTE TYPE |       ATTRIBUTE VALUE        |
       +---------------+------------------------------+
       |Availability   | library/idnkit/header-idnkit |
       +---------------+------------------------------+
       |Stability      | Committed                    |
       +---------------+------------------------------+
SEE ALSO
       libidnkit(3), idn_checkname(3), idn_comparenames(3), idn_decodename(3),
       idn_encodename(3), idn_nameinit(3), idn_result_tostring(3)



NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source was downloaded from  https://jprs.co.jp/idn/idnkit-2.3.tar.bz2

       Further information about this software can be found on the open source
       community website at https://jprs.co.jp/idn.



                                 Sep 21, 2012         idn_setlocalcheckfile(3)