<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>ICU 53.1: uspoof.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ICU 53.1
 <span id="projectnumber">53.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_55bf5c6bcedc2c5705af95fc7596ac50.html">icu</a></li><li class="navelem"><a class="el" href="dir_17c4e3d278dd0be6889e0e8c41145d45.html">source</a></li><li class="navelem"><a class="el" href="dir_50278085fbfb203a4ae8d13ac447741e.html">i18n</a></li><li class="navelem"><a class="el" href="dir_47d86980f74387e1e780cfdfbee4bf19.html">unicode</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">uspoof.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Unicode Security and Spoofing Detection, C API.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="utypes_8h_source.html">unicode/utypes.h</a>"</code><br/>
<code>#include "<a class="el" href="uset_8h_source.html">unicode/uset.h</a>"</code><br/>
<code>#include "<a class="el" href="parseerr_8h_source.html">unicode/parseerr.h</a>"</code><br/>
<code>#include "<a class="el" href="localpointer_8h_source.html">unicode/localpointer.h</a>"</code><br/>
<code>#include "<a class="el" href="unistr_8h_source.html">unicode/unistr.h</a>"</code><br/>
<code>#include "<a class="el" href="uniset_8h_source.html">unicode/uniset.h</a>"</code><br/>
</div>
<p><a href="uspoof_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceicu"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceicu.html">icu</a></td></tr>
<tr class="memdesc:namespaceicu"><td class="mdescLeft"> </td><td class="mdescRight">File <a class="el" href="coll_8h.html" title="C++ API: Collation Service. ">coll.h</a>. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ad5e4927218c9e62595a67378cf6e371f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad5e4927218c9e62595a67378cf6e371f"></a>
typedef struct <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a></td></tr>
<tr class="memdesc:ad5e4927218c9e62595a67378cf6e371f"><td class="mdescLeft"> </td><td class="mdescRight">typedef for C of USpoofChecker <br/></td></tr>
<tr class="separator:ad5e4927218c9e62595a67378cf6e371f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3f7748f370e9cc7f0c9a84eaa6165ddc"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="uspoof_8h.html#a0dbd60e53a571689baf65c63f4de8155">USpoofChecks</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#a3f7748f370e9cc7f0c9a84eaa6165ddc">USpoofChecks</a></td></tr>
<tr class="memdesc:a3f7748f370e9cc7f0c9a84eaa6165ddc"><td class="mdescLeft"> </td><td class="mdescRight">Enum for the kinds of checks that USpoofChecker can perform. <a href="#a3f7748f370e9cc7f0c9a84eaa6165ddc">More...</a><br/></td></tr>
<tr class="separator:a3f7748f370e9cc7f0c9a84eaa6165ddc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac129ea51214fb8cd249bb07500c1c2fc"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="uspoof_8h.html#a566eea7ea15156355085eb7ff5013852">URestrictionLevel</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#ac129ea51214fb8cd249bb07500c1c2fc">URestrictionLevel</a></td></tr>
<tr class="memdesc:ac129ea51214fb8cd249bb07500c1c2fc"><td class="mdescLeft"> </td><td class="mdescRight">Constants from UAX #39 for use in setRestrictionLevel(), and for returned identifier restriction levels in check results. <a href="#ac129ea51214fb8cd249bb07500c1c2fc">More...</a><br/></td></tr>
<tr class="separator:ac129ea51214fb8cd249bb07500c1c2fc"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a0dbd60e53a571689baf65c63f4de8155"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#a0dbd60e53a571689baf65c63f4de8155">USpoofChecks</a> { <br/>
  <a class="el" href="uspoof_8h.html#a0dbd60e53a571689baf65c63f4de8155adc4588fd7ff74c3a6e5cc91d3a6f5d60">USPOOF_SINGLE_SCRIPT_CONFUSABLE</a> = 1,
<a class="el" href="uspoof_8h.html#a0dbd60e53a571689baf65c63f4de8155a76a60327ab14a68342242aae60340106">USPOOF_MIXED_SCRIPT_CONFUSABLE</a> = 2,
<a class="el" href="uspoof_8h.html#a0dbd60e53a571689baf65c63f4de8155abfc834ae8c881e54a7922648d5fecead">USPOOF_WHOLE_SCRIPT_CONFUSABLE</a> = 4,
<a class="el" href="uspoof_8h.html#a0dbd60e53a571689baf65c63f4de8155ae65a72b384e76f7ac1cc4df1decd8057">USPOOF_ANY_CASE</a> = 8,
<br/>
  <a class="el" href="uspoof_8h.html#a0dbd60e53a571689baf65c63f4de8155a1977848d7ccac6f3640fa684b452f69a">USPOOF_RESTRICTION_LEVEL</a> = 16,
<a class="el" href="uspoof_8h.html#a0dbd60e53a571689baf65c63f4de8155a68b7d294c1566c1f4a74e2b3a952a138">USPOOF_SINGLE_SCRIPT</a> = USPOOF_RESTRICTION_LEVEL,
<a class="el" href="uspoof_8h.html#a0dbd60e53a571689baf65c63f4de8155a7324a51073ca18279da8706d8c21ee0c">USPOOF_INVISIBLE</a> = 32,
<a class="el" href="uspoof_8h.html#a0dbd60e53a571689baf65c63f4de8155a3f3e13d5b54cc156864a2aca221b3888">USPOOF_CHAR_LIMIT</a> = 64,
<br/>
  <a class="el" href="uspoof_8h.html#a0dbd60e53a571689baf65c63f4de8155a0fbfe4596de0672faf4f0d4f01a823f6">USPOOF_MIXED_NUMBERS</a> = 128,
<a class="el" href="uspoof_8h.html#a0dbd60e53a571689baf65c63f4de8155a4450adc366e2178c451d89b2ea244123">USPOOF_ALL_CHECKS</a> = 0xFFFF,
<a class="el" href="uspoof_8h.html#a0dbd60e53a571689baf65c63f4de8155aa7307e5bdc933ceba391fbbc22b382ab">USPOOF_AUX_INFO</a> = 0x40000000
<br/>
}</td></tr>
<tr class="memdesc:a0dbd60e53a571689baf65c63f4de8155"><td class="mdescLeft"> </td><td class="mdescRight">Enum for the kinds of checks that USpoofChecker can perform. <a href="uspoof_8h.html#a0dbd60e53a571689baf65c63f4de8155">More...</a><br/></td></tr>
<tr class="separator:a0dbd60e53a571689baf65c63f4de8155"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a566eea7ea15156355085eb7ff5013852"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#a566eea7ea15156355085eb7ff5013852">URestrictionLevel</a> { <br/>
  <a class="el" href="uspoof_8h.html#a566eea7ea15156355085eb7ff5013852a262982208b89a2649d0f31ea48e46765">USPOOF_ASCII</a> = 0x10000000,
<a class="el" href="uspoof_8h.html#a566eea7ea15156355085eb7ff5013852a0488c3736f11d8808ac55f72a3c6bde2">USPOOF_SINGLE_SCRIPT_RESTRICTIVE</a> = 0x20000000,
<a class="el" href="uspoof_8h.html#a566eea7ea15156355085eb7ff5013852af6dda9229dc422d3e8e41a23a1251060">USPOOF_HIGHLY_RESTRICTIVE</a> = 0x30000000,
<a class="el" href="uspoof_8h.html#a566eea7ea15156355085eb7ff5013852a06d4bf8b1c05dca9a9ec69a0e926e117">USPOOF_MODERATELY_RESTRICTIVE</a> = 0x40000000,
<br/>
  <a class="el" href="uspoof_8h.html#a566eea7ea15156355085eb7ff5013852af1e2132b4067af2aec3460c679f7e598">USPOOF_MINIMALLY_RESTRICTIVE</a> = 0x50000000,
<a class="el" href="uspoof_8h.html#a566eea7ea15156355085eb7ff5013852af8c3d86392c0d18d51b05390483a036e">USPOOF_UNRESTRICTIVE</a> = 0x60000000,
<a class="el" href="uspoof_8h.html#a566eea7ea15156355085eb7ff5013852a900ac32a2451a70f42c424445f0f3b6f">USPOOF_RESTRICTION_LEVEL_MASK</a> = 0x7F000000
<br/>
}</td></tr>
<tr class="memdesc:a566eea7ea15156355085eb7ff5013852"><td class="mdescLeft"> </td><td class="mdescRight">Constants from UAX #39 for use in setRestrictionLevel(), and for returned identifier restriction levels in check results. <a href="uspoof_8h.html#a566eea7ea15156355085eb7ff5013852">More...</a><br/></td></tr>
<tr class="separator:a566eea7ea15156355085eb7ff5013852"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:afeff54ce632c1357e914334009becb62"><td class="memItemLeft" align="right" valign="top"><a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#afeff54ce632c1357e914334009becb62">uspoof_open</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:afeff54ce632c1357e914334009becb62"><td class="mdescLeft"> </td><td class="mdescRight">Create a Unicode Spoof Checker, configured to perform all checks except for USPOOF_LOCALE_LIMIT and USPOOF_CHAR_LIMIT. <a href="#afeff54ce632c1357e914334009becb62">More...</a><br/></td></tr>
<tr class="separator:afeff54ce632c1357e914334009becb62"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa13a3dd9f673f9df317948eecab1a346"><td class="memItemLeft" align="right" valign="top"><a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#aa13a3dd9f673f9df317948eecab1a346">uspoof_openFromSerialized</a> (const void *data, int32_t length, int32_t *pActualLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:aa13a3dd9f673f9df317948eecab1a346"><td class="mdescLeft"> </td><td class="mdescRight">Open a Spoof checker from its serialized from, stored in 32-bit-aligned memory. <a href="#aa13a3dd9f673f9df317948eecab1a346">More...</a><br/></td></tr>
<tr class="separator:aa13a3dd9f673f9df317948eecab1a346"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5332f41a9d13aec2cc115e6a24d08595"><td class="memItemLeft" align="right" valign="top"><a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#a5332f41a9d13aec2cc115e6a24d08595">uspoof_openFromSource</a> (const char *confusables, int32_t confusablesLen, const char *confusablesWholeScript, int32_t confusablesWholeScriptLen, int32_t *errType, <a class="el" href="structUParseError.html">UParseError</a> *pe, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a5332f41a9d13aec2cc115e6a24d08595"><td class="mdescLeft"> </td><td class="mdescRight">Open a Spoof Checker from the source form of the spoof data. <a href="#a5332f41a9d13aec2cc115e6a24d08595">More...</a><br/></td></tr>
<tr class="separator:a5332f41a9d13aec2cc115e6a24d08595"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab63b4f7780b1d6c57a31624ad5c3db41"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#ab63b4f7780b1d6c57a31624ad5c3db41">uspoof_close</a> (<a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> *sc)</td></tr>
<tr class="memdesc:ab63b4f7780b1d6c57a31624ad5c3db41"><td class="mdescLeft"> </td><td class="mdescRight">Close a Spoof Checker, freeing any memory that was being held by its implementation. <a href="#ab63b4f7780b1d6c57a31624ad5c3db41">More...</a><br/></td></tr>
<tr class="separator:ab63b4f7780b1d6c57a31624ad5c3db41"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a6a3fff21c2aa515d3e16da47609a48"><td class="memItemLeft" align="right" valign="top"><a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#a5a6a3fff21c2aa515d3e16da47609a48">uspoof_clone</a> (const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> *sc, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a5a6a3fff21c2aa515d3e16da47609a48"><td class="mdescLeft"> </td><td class="mdescRight">Clone a Spoof Checker. <a href="#a5a6a3fff21c2aa515d3e16da47609a48">More...</a><br/></td></tr>
<tr class="separator:a5a6a3fff21c2aa515d3e16da47609a48"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1600b90af8fde36cf87d6c6be8df5af0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#a1600b90af8fde36cf87d6c6be8df5af0">uspoof_setChecks</a> (<a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> *sc, int32_t checks, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a1600b90af8fde36cf87d6c6be8df5af0"><td class="mdescLeft"> </td><td class="mdescRight">Specify the set of checks that will be performed by the check functions of this Spoof Checker. <a href="#a1600b90af8fde36cf87d6c6be8df5af0">More...</a><br/></td></tr>
<tr class="separator:a1600b90af8fde36cf87d6c6be8df5af0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a11c9d7b315c2f4b1011619bd4df91cf8"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#a11c9d7b315c2f4b1011619bd4df91cf8">uspoof_getChecks</a> (const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> *sc, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a11c9d7b315c2f4b1011619bd4df91cf8"><td class="mdescLeft"> </td><td class="mdescRight">Get the set of checks that this Spoof Checker has been configured to perform. <a href="#a11c9d7b315c2f4b1011619bd4df91cf8">More...</a><br/></td></tr>
<tr class="separator:a11c9d7b315c2f4b1011619bd4df91cf8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a27b9d377dbbfa2f8d678a9d3e46b546b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#a27b9d377dbbfa2f8d678a9d3e46b546b">uspoof_setRestrictionLevel</a> (<a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> *sc, <a class="el" href="uspoof_8h.html#a566eea7ea15156355085eb7ff5013852">URestrictionLevel</a> restrictionLevel)</td></tr>
<tr class="memdesc:a27b9d377dbbfa2f8d678a9d3e46b546b"><td class="mdescLeft"> </td><td class="mdescRight">Set the loosest restriction level allowed. <a href="#a27b9d377dbbfa2f8d678a9d3e46b546b">More...</a><br/></td></tr>
<tr class="separator:a27b9d377dbbfa2f8d678a9d3e46b546b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4d67fe2cfbff34474ad6d85a8135e785"><td class="memItemLeft" align="right" valign="top"><a class="el" href="uspoof_8h.html#a566eea7ea15156355085eb7ff5013852">URestrictionLevel</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#a4d67fe2cfbff34474ad6d85a8135e785">uspoof_getRestrictionLevel</a> (const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> *sc)</td></tr>
<tr class="memdesc:a4d67fe2cfbff34474ad6d85a8135e785"><td class="mdescLeft"> </td><td class="mdescRight">Get the Restriction Level that will be tested if the checks include RESTRICTION_LEVEL. <a href="#a4d67fe2cfbff34474ad6d85a8135e785">More...</a><br/></td></tr>
<tr class="separator:a4d67fe2cfbff34474ad6d85a8135e785"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aca1b0d0630a88af80c56e8205761f6a1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#aca1b0d0630a88af80c56e8205761f6a1">uspoof_setAllowedLocales</a> (<a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> *sc, const char *localesList, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:aca1b0d0630a88af80c56e8205761f6a1"><td class="mdescLeft"> </td><td class="mdescRight">Limit characters that are acceptable in identifiers being checked to those normally used with the languages associated with the specified locales. <a href="#aca1b0d0630a88af80c56e8205761f6a1">More...</a><br/></td></tr>
<tr class="separator:aca1b0d0630a88af80c56e8205761f6a1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae9105b5d6d3dd326dcfd60fe3730f5d0"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#ae9105b5d6d3dd326dcfd60fe3730f5d0">uspoof_getAllowedLocales</a> (<a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> *sc, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:ae9105b5d6d3dd326dcfd60fe3730f5d0"><td class="mdescLeft"> </td><td class="mdescRight">Get a list of locales for the scripts that are acceptable in strings to be checked. <a href="#ae9105b5d6d3dd326dcfd60fe3730f5d0">More...</a><br/></td></tr>
<tr class="separator:ae9105b5d6d3dd326dcfd60fe3730f5d0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe089c3471eb52dbbd7268c3eb9db695"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#abe089c3471eb52dbbd7268c3eb9db695">uspoof_setAllowedChars</a> (<a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> *sc, const <a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> *chars, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:abe089c3471eb52dbbd7268c3eb9db695"><td class="mdescLeft"> </td><td class="mdescRight">Limit the acceptable characters to those specified by a Unicode Set. <a href="#abe089c3471eb52dbbd7268c3eb9db695">More...</a><br/></td></tr>
<tr class="separator:abe089c3471eb52dbbd7268c3eb9db695"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab15e60d2aaaa9ea5d49eb4524c41fa9e"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#ab15e60d2aaaa9ea5d49eb4524c41fa9e">uspoof_getAllowedChars</a> (const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> *sc, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:ab15e60d2aaaa9ea5d49eb4524c41fa9e"><td class="mdescLeft"> </td><td class="mdescRight">Get a USet for the characters permitted in an identifier. <a href="#ab15e60d2aaaa9ea5d49eb4524c41fa9e">More...</a><br/></td></tr>
<tr class="separator:ab15e60d2aaaa9ea5d49eb4524c41fa9e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6193792292d9ead15f9832fcef6a704b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#a6193792292d9ead15f9832fcef6a704b">uspoof_setAllowedUnicodeSet</a> (<a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> *sc, const <a class="el" href="classicu_1_1UnicodeSet.html">icu::UnicodeSet</a> *chars, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a6193792292d9ead15f9832fcef6a704b"><td class="mdescLeft"> </td><td class="mdescRight">Limit the acceptable characters to those specified by a Unicode Set. <a href="#a6193792292d9ead15f9832fcef6a704b">More...</a><br/></td></tr>
<tr class="separator:a6193792292d9ead15f9832fcef6a704b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a882de7faa9049cb6c65f8a949a07a4e9"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classicu_1_1UnicodeSet.html">icu::UnicodeSet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#a882de7faa9049cb6c65f8a949a07a4e9">uspoof_getAllowedUnicodeSet</a> (const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> *sc, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a882de7faa9049cb6c65f8a949a07a4e9"><td class="mdescLeft"> </td><td class="mdescRight">Get a UnicodeSet for the characters permitted in an identifier. <a href="#a882de7faa9049cb6c65f8a949a07a4e9">More...</a><br/></td></tr>
<tr class="separator:a882de7faa9049cb6c65f8a949a07a4e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa6628f1b69565e660ecbb1f380ac72dc"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#aa6628f1b69565e660ecbb1f380ac72dc">uspoof_check</a> (const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> *sc, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *id, int32_t length, int32_t *position, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:aa6628f1b69565e660ecbb1f380ac72dc"><td class="mdescLeft"> </td><td class="mdescRight">Check the specified string for possible security issues. <a href="#aa6628f1b69565e660ecbb1f380ac72dc">More...</a><br/></td></tr>
<tr class="separator:aa6628f1b69565e660ecbb1f380ac72dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac3c9dc9db498c19758e4144655919621"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#ac3c9dc9db498c19758e4144655919621">uspoof_checkUTF8</a> (const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> *sc, const char *id, int32_t length, int32_t *position, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:ac3c9dc9db498c19758e4144655919621"><td class="mdescLeft"> </td><td class="mdescRight">Check the specified string for possible security issues. <a href="#ac3c9dc9db498c19758e4144655919621">More...</a><br/></td></tr>
<tr class="separator:ac3c9dc9db498c19758e4144655919621"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab826cb99a2ca41e8030ff55f471a9881"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#ab826cb99a2ca41e8030ff55f471a9881">uspoof_checkUnicodeString</a> (const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> *sc, const <a class="el" href="classicu_1_1UnicodeString.html">icu::UnicodeString</a> &id, int32_t *position, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:ab826cb99a2ca41e8030ff55f471a9881"><td class="mdescLeft"> </td><td class="mdescRight">Check the specified string for possible security issues. <a href="#ab826cb99a2ca41e8030ff55f471a9881">More...</a><br/></td></tr>
<tr class="separator:ab826cb99a2ca41e8030ff55f471a9881"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac96fdf642bfd9efcd0d9956bd76cadaa"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#ac96fdf642bfd9efcd0d9956bd76cadaa">uspoof_areConfusable</a> (const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> *sc, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *id1, int32_t length1, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *id2, int32_t length2, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:ac96fdf642bfd9efcd0d9956bd76cadaa"><td class="mdescLeft"> </td><td class="mdescRight">Check the whether two specified strings are visually confusable. <a href="#ac96fdf642bfd9efcd0d9956bd76cadaa">More...</a><br/></td></tr>
<tr class="separator:ac96fdf642bfd9efcd0d9956bd76cadaa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae6f653c41a24abee03afb24e22d93466"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#ae6f653c41a24abee03afb24e22d93466">uspoof_areConfusableUTF8</a> (const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> *sc, const char *id1, int32_t length1, const char *id2, int32_t length2, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:ae6f653c41a24abee03afb24e22d93466"><td class="mdescLeft"> </td><td class="mdescRight">Check the whether two specified strings are visually confusable. <a href="#ae6f653c41a24abee03afb24e22d93466">More...</a><br/></td></tr>
<tr class="separator:ae6f653c41a24abee03afb24e22d93466"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66d450097ce8ceca668cbcf21196b9ad"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#a66d450097ce8ceca668cbcf21196b9ad">uspoof_areConfusableUnicodeString</a> (const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> *sc, const <a class="el" href="classicu_1_1UnicodeString.html">icu::UnicodeString</a> &s1, const <a class="el" href="classicu_1_1UnicodeString.html">icu::UnicodeString</a> &s2, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a66d450097ce8ceca668cbcf21196b9ad"><td class="mdescLeft"> </td><td class="mdescRight">Check the whether two specified strings are visually confusable. <a href="#a66d450097ce8ceca668cbcf21196b9ad">More...</a><br/></td></tr>
<tr class="separator:a66d450097ce8ceca668cbcf21196b9ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac534ff73614148bad6c93320101f0c47"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#ac534ff73614148bad6c93320101f0c47">uspoof_getSkeleton</a> (const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> *sc, uint32_t type, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *id, int32_t length, <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *dest, int32_t destCapacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:ac534ff73614148bad6c93320101f0c47"><td class="mdescLeft"> </td><td class="mdescRight">Get the "skeleton" for an identifier. <a href="#ac534ff73614148bad6c93320101f0c47">More...</a><br/></td></tr>
<tr class="separator:ac534ff73614148bad6c93320101f0c47"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a09942c6a49df736928aa5a5c1d329a83"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#a09942c6a49df736928aa5a5c1d329a83">uspoof_getSkeletonUTF8</a> (const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> *sc, uint32_t type, const char *id, int32_t length, char *dest, int32_t destCapacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a09942c6a49df736928aa5a5c1d329a83"><td class="mdescLeft"> </td><td class="mdescRight">Get the "skeleton" for an identifier. <a href="#a09942c6a49df736928aa5a5c1d329a83">More...</a><br/></td></tr>
<tr class="separator:a09942c6a49df736928aa5a5c1d329a83"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe14cbde824abd936c704b15e397a015"><td class="memItemLeft" align="right" valign="top"><a class="el" href="utypes_8h.html#ab9d90a30137b6ec046fe59e79b09745a">U_I18N_API</a> <a class="el" href="classicu_1_1UnicodeString.html">icu::UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#afe14cbde824abd936c704b15e397a015">uspoof_getSkeletonUnicodeString</a> (const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> *sc, uint32_t type, const <a class="el" href="classicu_1_1UnicodeString.html">icu::UnicodeString</a> &id, <a class="el" href="classicu_1_1UnicodeString.html">icu::UnicodeString</a> &dest, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:afe14cbde824abd936c704b15e397a015"><td class="mdescLeft"> </td><td class="mdescRight">Get the "skeleton" for an identifier. <a href="#afe14cbde824abd936c704b15e397a015">More...</a><br/></td></tr>
<tr class="separator:afe14cbde824abd936c704b15e397a015"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a24be9382a3430bbf38abef96f168400b"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#a24be9382a3430bbf38abef96f168400b">uspoof_getInclusionSet</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a24be9382a3430bbf38abef96f168400b"><td class="mdescLeft"> </td><td class="mdescRight">Get the set of Candidate Characters for Inclusion in Identifiers, as defined in Unicode UAX #31, <a href="http://www.unicode.org/reports/tr31/#Table_Candidate_Characters_for_Inclusion_in_Identifiers">http://www.unicode.org/reports/tr31/#Table_Candidate_Characters_for_Inclusion_in_Identifiers</a>. <a href="#a24be9382a3430bbf38abef96f168400b">More...</a><br/></td></tr>
<tr class="separator:a24be9382a3430bbf38abef96f168400b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0eda41b7dffbb123fa62ac1271eee721"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#a0eda41b7dffbb123fa62ac1271eee721">uspoof_getRecommendedSet</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a0eda41b7dffbb123fa62ac1271eee721"><td class="mdescLeft"> </td><td class="mdescRight">Get the set of characters from Recommended Scripts for Inclusion in Identifiers, as defined in Unicode UAX #31, <a href="http://www.unicode.org/reports/tr31/#Table_Recommended_Scripts">http://www.unicode.org/reports/tr31/#Table_Recommended_Scripts</a>. <a href="#a0eda41b7dffbb123fa62ac1271eee721">More...</a><br/></td></tr>
<tr class="separator:a0eda41b7dffbb123fa62ac1271eee721"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a30b3d5dcf1fa794ece93b32608aa803f"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classicu_1_1UnicodeSet.html">icu::UnicodeSet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#a30b3d5dcf1fa794ece93b32608aa803f">uspoof_getInclusionUnicodeSet</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a30b3d5dcf1fa794ece93b32608aa803f"><td class="mdescLeft"> </td><td class="mdescRight">Get the set of Candidate Characters for Inclusion in Identifiers, as defined in Unicode UAX #31, <a href="http://www.unicode.org/reports/tr31/#Table_Candidate_Characters_for_Inclusion_in_Identifiers">http://www.unicode.org/reports/tr31/#Table_Candidate_Characters_for_Inclusion_in_Identifiers</a>. <a href="#a30b3d5dcf1fa794ece93b32608aa803f">More...</a><br/></td></tr>
<tr class="separator:a30b3d5dcf1fa794ece93b32608aa803f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6693fd20b81ff5adf95b5798fbc818f1"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classicu_1_1UnicodeSet.html">icu::UnicodeSet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#a6693fd20b81ff5adf95b5798fbc818f1">uspoof_getRecommendedUnicodeSet</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a6693fd20b81ff5adf95b5798fbc818f1"><td class="mdescLeft"> </td><td class="mdescRight">Get the set of characters from Recommended Scripts for Inclusion in Identifiers, as defined in Unicode UAX #31, <a href="http://www.unicode.org/reports/tr31/#Table_Recommended_Scripts">http://www.unicode.org/reports/tr31/#Table_Recommended_Scripts</a>. <a href="#a6693fd20b81ff5adf95b5798fbc818f1">More...</a><br/></td></tr>
<tr class="separator:a6693fd20b81ff5adf95b5798fbc818f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a808f6fefabd028ea78931f85ec634022"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="uspoof_8h.html#a808f6fefabd028ea78931f85ec634022">uspoof_serialize</a> (<a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> *sc, void *data, int32_t capacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a808f6fefabd028ea78931f85ec634022"><td class="mdescLeft"> </td><td class="mdescRight">Serialize the data for a spoof detector into a chunk of memory. <a href="#a808f6fefabd028ea78931f85ec634022">More...</a><br/></td></tr>
<tr class="separator:a808f6fefabd028ea78931f85ec634022"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Unicode Security and Spoofing Detection, C API. </p>
<p>These functions are intended to check strings, typically identifiers of some type, such as URLs, for the presence of characters that are likely to be visually confusing - for cases where the displayed form of an identifier may not be what it appears to be.</p>
<p>Unicode Technical Report #36, <a href="http://unicode.org/reports/tr36,">http://unicode.org/reports/tr36,</a> and Unicode Technical Standard #39, <a href="http://unicode.org/reports/tr39">http://unicode.org/reports/tr39</a> "Unicode security considerations", give more background on security an spoofing issues with Unicode identifiers. The tests and checks provided by this module implement the recommendations from those Unicode documents.</p>
<p>The tests available on identifiers fall into two general categories:</p>
<ol type="1">
<li>Single identifier tests. Check whether an identifier is potentially confusable with any other string, or is suspicious for other reasons.</li>
<li>Two identifier tests. Check whether two specific identifiers are confusable. This does not consider whether either of strings is potentially confusable with any string other than the exact one specified.</li>
</ol>
<p>The steps to perform confusability testing are</p>
<ol type="1">
<li>Open a USpoofChecker.</li>
<li>Configure the USPoofChecker for the desired set of tests. The tests that will be performed are specified by a set of USpoofChecks flags.</li>
<li>Perform the checks using the pre-configured USpoofChecker. The results indicate which (if any) of the selected tests have identified possible problems with the identifier. Results are reported as a set of USpoofChecks flags; this mirrors the form in which the set of tests to perform was originally specified to the USpoofChecker.</li>
</ol>
<p>A USpoofChecker may be used repeatedly to perform checks on any number of identifiers.</p>
<p>Thread Safety: The test functions for checking a single identifier, or for testing whether two identifiers are possible confusable, are thread safe. They may called concurrently, from multiple threads, using the same USpoofChecker instance.</p>
<p>More generally, the standard ICU thread safety rules apply: functions that take a const USpoofChecker parameter are thread safe. Those that take a non-const USpoofChecier are not thread safe.</p>
<p>Descriptions of the available checks.</p>
<p>When testing whether pairs of identifiers are confusable, with the <a class="el" href="uspoof_8h.html#ac96fdf642bfd9efcd0d9956bd76cadaa" title="Check the whether two specified strings are visually confusable. ">uspoof_areConfusable()</a> family of functions, the relevant tests are</p>
<ol type="1">
<li>USPOOF_SINGLE_SCRIPT_CONFUSABLE: All of the characters from the two identifiers are from a single script, and the two identifiers are visually confusable.</li>
<li>USPOOF_MIXED_SCRIPT_CONFUSABLE: At least one of the identifiers contains characters from more than one script, and the two identifiers are visually confusable.</li>
<li>USPOOF_WHOLE_SCRIPT_CONFUSABLE: Each of the two identifiers is of a single script, but the two identifiers are from different scripts, and they are visually confusable.</li>
</ol>
<p>The safest approach is to enable all three of these checks as a group.</p>
<p>USPOOF_ANY_CASE is a modifier for the above tests. If the identifiers being checked can be of mixed case and are used in a case-sensitive manner, this option should be specified.</p>
<p>If the identifiers being checked are used in a case-insensitive manner, and if they are displayed to users in lower-case form only, the USPOOF_ANY_CASE option should not be specified. Confusabality issues involving upper case letters will not be reported.</p>
<p>When performing tests on a single identifier, with the <a class="el" href="uspoof_8h.html#aa6628f1b69565e660ecbb1f380ac72dc" title="Check the specified string for possible security issues. ">uspoof_check()</a> family of functions, the relevant tests are:</p>
<ol type="1">
<li>USPOOF_MIXED_SCRIPT_CONFUSABLE: the identifier contains characters from multiple scripts, and there exists an identifier of a single script that is visually confusable.</li>
<li>USPOOF_WHOLE_SCRIPT_CONFUSABLE: the identifier consists of characters from a single script, and there exists a visually confusable identifier. The visually confusable identifier also consists of characters from a single script. but not the same script as the identifier being checked.</li>
<li>USPOOF_ANY_CASE: modifies the mixed script and whole script confusables tests. If specified, the checks will consider confusable characters of any case. If this flag is not set, the test is performed assuming case folded identifiers.</li>
<li>USPOOF_SINGLE_SCRIPT: check that the identifier contains only characters from a single script. (Characters from the 'common' and 'inherited' scripts are ignored.) This is not a test for confusable identifiers</li>
<li>USPOOF_INVISIBLE: check an identifier for the presence of invisible characters, such as zero-width spaces, or character sequences that are likely not to display, such as multiple occurrences of the same non-spacing mark. This check does not test the input string as a whole for conformance to any particular syntax for identifiers.</li>
<li>USPOOF_CHAR_LIMIT: check that an identifier contains only characters from a specified set of acceptable characters. See <a class="el" href="uspoof_8h.html#abe089c3471eb52dbbd7268c3eb9db695" title="Limit the acceptable characters to those specified by a Unicode Set. ">uspoof_setAllowedChars()</a> and <a class="el" href="uspoof_8h.html#aca1b0d0630a88af80c56e8205761f6a1" title="Limit characters that are acceptable in identifiers being checked to those normally used with the lan...">uspoof_setAllowedLocales()</a>.</li>
</ol>
<p>Note on Scripts: Characters from the Unicode Scripts "Common" and "Inherited" are ignored when considering the script of an identifier. Common characters include digits and symbols that are normally used with text from more than one script.</p>
<p>Identifier Skeletons: A skeleton is a transformation of an identifier, such that all identifiers that are confusable with each other have the same skeleton. Using skeletons, it is possible to build a dictionary data structure for a set of identifiers, and then quickly test whether a new identifier is confusable with an identifier already in the set. The <a class="el" href="uspoof_8h.html#ac534ff73614148bad6c93320101f0c47" title="Get the "skeleton" for an identifier. ">uspoof_getSkeleton()</a> family of functions will produce the skeleton from an identifier.</p>
<p>Note that skeletons are not guaranteed to be stable between versions of Unicode or ICU, so an applications should not rely on creating a permanent, or difficult to update, database of skeletons. Instabilities result from identifying new pairs or sequences of characters that are visually confusable, and thus must be mapped to the same skeleton character(s). </p>
<p>Definition in file <a class="el" href="uspoof_8h_source.html">uspoof.h</a>.</p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ac129ea51214fb8cd249bb07500c1c2fc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="uspoof_8h.html#a566eea7ea15156355085eb7ff5013852">URestrictionLevel</a> <a class="el" href="uspoof_8h.html#a566eea7ea15156355085eb7ff5013852">URestrictionLevel</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constants from UAX #39 for use in setRestrictionLevel(), and for returned identifier restriction levels in check results. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005130">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</div>
</div>
<a class="anchor" id="a3f7748f370e9cc7f0c9a84eaa6165ddc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="uspoof_8h.html#a0dbd60e53a571689baf65c63f4de8155">USpoofChecks</a> <a class="el" href="uspoof_8h.html#a0dbd60e53a571689baf65c63f4de8155">USpoofChecks</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enum for the kinds of checks that USpoofChecker can perform. </p>
<p>These enum values are used both to select the set of checks that will be performed, and to report results from the check function.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005129">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="a566eea7ea15156355085eb7ff5013852"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="uspoof_8h.html#a566eea7ea15156355085eb7ff5013852">URestrictionLevel</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constants from UAX #39 for use in setRestrictionLevel(), and for returned identifier restriction levels in check results. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005130">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a566eea7ea15156355085eb7ff5013852a262982208b89a2649d0f31ea48e46765"></a>USPOOF_ASCII</em> </td><td class="fielddoc">
<p>Only ASCII characters: U+0000..U+007F. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005160">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a566eea7ea15156355085eb7ff5013852a0488c3736f11d8808ac55f72a3c6bde2"></a>USPOOF_SINGLE_SCRIPT_RESTRICTIVE</em> </td><td class="fielddoc">
<p>All characters in each identifier must be from a single script. </p>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000216">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 53 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a566eea7ea15156355085eb7ff5013852af6dda9229dc422d3e8e41a23a1251060"></a>USPOOF_HIGHLY_RESTRICTIVE</em> </td><td class="fielddoc">
<p>All characters in each identifier must be from a single script, or from the combinations: Latin + Han + Hiragana + Katakana; Latin + Han + Bopomofo; or Latin + Han + Hangul. </p>
<p>Note that this level will satisfy the vast majority of Latin-script users; also that TR36 has ASCII instead of Latin.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005161">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a566eea7ea15156355085eb7ff5013852a06d4bf8b1c05dca9a9ec69a0e926e117"></a>USPOOF_MODERATELY_RESTRICTIVE</em> </td><td class="fielddoc">
<p>Allow Latin with other scripts except Cyrillic, Greek, Cherokee Otherwise, the same as Highly Restrictive. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005162">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a566eea7ea15156355085eb7ff5013852af1e2132b4067af2aec3460c679f7e598"></a>USPOOF_MINIMALLY_RESTRICTIVE</em> </td><td class="fielddoc">
<p>Allow arbitrary mixtures of scripts. </p>
<p>Otherwise, the same as Moderately Restrictive.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005163">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a566eea7ea15156355085eb7ff5013852af8c3d86392c0d18d51b05390483a036e"></a>USPOOF_UNRESTRICTIVE</em> </td><td class="fielddoc">
<p>Any valid identifiers, including characters outside of the Identifier Profile. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005164">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a566eea7ea15156355085eb7ff5013852a900ac32a2451a70f42c424445f0f3b6f"></a>USPOOF_RESTRICTION_LEVEL_MASK</em> </td><td class="fielddoc">
<p>Mask for selecting the Restriction Level bits from the return value of <a class="el" href="uspoof_8h.html#aa6628f1b69565e660ecbb1f380ac72dc" title="Check the specified string for possible security issues. ">uspoof_check()</a>. </p>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000217">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 53 </dd></dl>
</td></tr>
</table>
<p>Definition at line <a class="el" href="uspoof_8h_source.html#l00266">266</a> of file <a class="el" href="uspoof_8h_source.html">uspoof.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0dbd60e53a571689baf65c63f4de8155"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="uspoof_8h.html#a0dbd60e53a571689baf65c63f4de8155">USpoofChecks</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enum for the kinds of checks that USpoofChecker can perform. </p>
<p>These enum values are used both to select the set of checks that will be performed, and to report results from the check function.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005129">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a0dbd60e53a571689baf65c63f4de8155adc4588fd7ff74c3a6e5cc91d3a6f5d60"></a>USPOOF_SINGLE_SCRIPT_CONFUSABLE</em> </td><td class="fielddoc">
<p>Single script confusable test. </p>
<p>When testing whether two identifiers are confusable, report that they are if both are from the same script and they are visually confusable. Note: this test is not applicable to a check of a single identifier. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0dbd60e53a571689baf65c63f4de8155a76a60327ab14a68342242aae60340106"></a>USPOOF_MIXED_SCRIPT_CONFUSABLE</em> </td><td class="fielddoc">
<p>Mixed script confusable test. </p>
<p>When checking a single identifier, report a problem if the identifier contains multiple scripts, and is confusable with some other identifier in a single script When testing whether two identifiers are confusable, report that they are if the two IDs are visually confusable, and at least one contains characters from more than one script. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0dbd60e53a571689baf65c63f4de8155abfc834ae8c881e54a7922648d5fecead"></a>USPOOF_WHOLE_SCRIPT_CONFUSABLE</em> </td><td class="fielddoc">
<p>Whole script confusable test. </p>
<p>When checking a single identifier, report a problem if The identifier is of a single script, and there exists a confusable identifier in another script. When testing whether two identifiers are confusable, report that they are if each is of a single script, the scripts of the two identifiers are different, and the identifiers are visually confusable. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0dbd60e53a571689baf65c63f4de8155ae65a72b384e76f7ac1cc4df1decd8057"></a>USPOOF_ANY_CASE</em> </td><td class="fielddoc">
<p>Any Case Modifier for confusable identifier tests. </p>
<p>If specified, consider all characters, of any case, when looking for confusables. If USPOOF_ANY_CASE is not specified, identifiers being checked are assumed to have been case folded. Upper case confusable characters will not be checked. Selects between Lower Case Confusable and Any Case Confusable. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0dbd60e53a571689baf65c63f4de8155a1977848d7ccac6f3640fa684b452f69a"></a>USPOOF_RESTRICTION_LEVEL</em> </td><td class="fielddoc">
<p>Check that an identifier is no looser than the specified RestrictionLevel. </p>
<p>The default if uspoof_setRestrctionLevel() is not called is HIGHLY_RESTRICTIVE.</p>
<p>If USPOOF_AUX_INFO is enabled the actual restriction level of the identifier being tested will also be returned by <a class="el" href="uspoof_8h.html#aa6628f1b69565e660ecbb1f380ac72dc" title="Check the specified string for possible security issues. ">uspoof_check()</a>.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="uspoof_8h.html#a566eea7ea15156355085eb7ff5013852" title="Constants from UAX #39 for use in setRestrictionLevel(), and for returned identifier restriction leve...">URestrictionLevel</a> </dd>
<dd>
<a class="el" href="uspoof_8h.html#a27b9d377dbbfa2f8d678a9d3e46b546b" title="Set the loosest restriction level allowed. ">uspoof_setRestrictionLevel</a> </dd>
<dd>
<a class="el" href="uspoof_8h.html#a0dbd60e53a571689baf65c63f4de8155aa7307e5bdc933ceba391fbbc22b382ab" title="Enable the return of auxillary (non-error) information in the upper bits of the check results value...">USPOOF_AUX_INFO</a></dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005156">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0dbd60e53a571689baf65c63f4de8155a68b7d294c1566c1f4a74e2b3a952a138"></a>USPOOF_SINGLE_SCRIPT</em> </td><td class="fielddoc">
<p>Check that an identifier contains only characters from a single script (plus chars from the common and inherited scripts.) Applies to checks of a single identifier check only. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000276">Deprecated:</a></b></dt><dd>ICU 51 Use RESTRICTION_LEVEL instead. </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0dbd60e53a571689baf65c63f4de8155a7324a51073ca18279da8706d8c21ee0c"></a>USPOOF_INVISIBLE</em> </td><td class="fielddoc">
<p>Check an identifier for the presence of invisible characters, such as zero-width spaces, or character sequences that are likely not to display, such as multiple occurrences of the same non-spacing mark. </p>
<p>This check does not test the input string as a whole for conformance to any particular syntax for identifiers. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0dbd60e53a571689baf65c63f4de8155a3f3e13d5b54cc156864a2aca221b3888"></a>USPOOF_CHAR_LIMIT</em> </td><td class="fielddoc">
<p>Check that an identifier contains only characters from a specified set of acceptable characters. </p>
<p>See <a class="el" href="uspoof_8h.html#abe089c3471eb52dbbd7268c3eb9db695" title="Limit the acceptable characters to those specified by a Unicode Set. ">uspoof_setAllowedChars()</a> and <a class="el" href="uspoof_8h.html#aca1b0d0630a88af80c56e8205761f6a1" title="Limit characters that are acceptable in identifiers being checked to those normally used with the lan...">uspoof_setAllowedLocales()</a>. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0dbd60e53a571689baf65c63f4de8155a0fbfe4596de0672faf4f0d4f01a823f6"></a>USPOOF_MIXED_NUMBERS</em> </td><td class="fielddoc">
<p>Check that an identifier does not include decimal digits from more than one numbering system. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005157">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0dbd60e53a571689baf65c63f4de8155a4450adc366e2178c451d89b2ea244123"></a>USPOOF_ALL_CHECKS</em> </td><td class="fielddoc">
<p>Enable all spoof checks. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005158">Stable:</a></b></dt><dd>ICU 4.6 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a0dbd60e53a571689baf65c63f4de8155aa7307e5bdc933ceba391fbbc22b382ab"></a>USPOOF_AUX_INFO</em> </td><td class="fielddoc">
<p>Enable the return of auxillary (non-error) information in the upper bits of the check results value. </p>
<p>If this "check" is not enabled, the results of <a class="el" href="uspoof_8h.html#aa6628f1b69565e660ecbb1f380ac72dc" title="Check the specified string for possible security issues. ">uspoof_check()</a> will be zero when an identifier passes all of the enabled checks.</p>
<p>If this "check" is enabled, (<a class="el" href="uspoof_8h.html#aa6628f1b69565e660ecbb1f380ac72dc" title="Check the specified string for possible security issues. ">uspoof_check()</a> & USPOOF_ALL_CHECKS) will be zero when an identifier passes all checks.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005159">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</td></tr>
</table>
<p>Definition at line <a class="el" href="uspoof_8h_source.html#l00154">154</a> of file <a class="el" href="uspoof_8h_source.html">uspoof.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ac96fdf642bfd9efcd0d9956bd76cadaa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t uspoof_areConfusable </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td>
<td class="paramname"><em>sc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>id1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>length1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>id2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>length2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check the whether two specified strings are visually confusable. </p>
<p>The types of confusability to be tested - single script, mixed script, or whole script - are determined by the check options set for the USpoofChecker.</p>
<p>The tests to be performed are controlled by the flags USPOOF_SINGLE_SCRIPT_CONFUSABLE USPOOF_MIXED_SCRIPT_CONFUSABLE USPOOF_WHOLE_SCRIPT_CONFUSABLE At least one of these tests must be selected.</p>
<p>USPOOF_ANY_CASE is a modifier for the tests. Select it if the identifiers may be of mixed case. If identifiers are case folded for comparison and display to the user, do not select the USPOOF_ANY_CASE option.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sc</td><td>The USpoofChecker </td></tr>
<tr><td class="paramname">id1</td><td>The first of the two identifiers to be compared for confusability. The strings are in UTF-16 format. </td></tr>
<tr><td class="paramname">length1</td><td>the length of the first identifer, expressed in 16 bit UTF-16 code units, or -1 if the string is nul terminated. </td></tr>
<tr><td class="paramname">id2</td><td>The second of the two identifiers to be compared for confusability. The identifiers are in UTF-16 format. </td></tr>
<tr><td class="paramname">length2</td><td>The length of the second identifiers, expressed in 16 bit UTF-16 code units, or -1 if the string is nul terminated. </td></tr>
<tr><td class="paramname">status</td><td>The error code, set if an error occurred while attempting to perform the check. Confusability of the identifiers is not reported here, but through this function's return value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An integer value with bit(s) set corresponding to the type of confusability found, as defined by enum USpoofChecks. Zero is returned if the identifiers are not confusable. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005149">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a66d450097ce8ceca668cbcf21196b9ad"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t uspoof_areConfusableUnicodeString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td>
<td class="paramname"><em>sc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">icu::UnicodeString</a> & </td>
<td class="paramname"><em>s1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">icu::UnicodeString</a> & </td>
<td class="paramname"><em>s2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check the whether two specified strings are visually confusable. </p>
<p>The types of confusability to be tested - single script, mixed script, or whole script - are determined by the check options set for the USpoofChecker.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sc</td><td>The USpoofChecker </td></tr>
<tr><td class="paramname">s1</td><td>The first of the two identifiers to be compared for confusability. The strings are in UTF-8 format. </td></tr>
<tr><td class="paramname">s2</td><td>The second of the two identifiers to be compared for confusability. The strings are in UTF-8 format. </td></tr>
<tr><td class="paramname">status</td><td>The error code, set if an error occurred while attempting to perform the check. Confusability of the identifiers is not reported here, but through this function's return value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An integer value with bit(s) set corresponding to the type of confusability found, as defined by enum USpoofChecks. Zero is returned if the identifiers are not confusable. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005151">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="ae6f653c41a24abee03afb24e22d93466"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t uspoof_areConfusableUTF8 </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td>
<td class="paramname"><em>sc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>id1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>length1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>id2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>length2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check the whether two specified strings are visually confusable. </p>
<p>The types of confusability to be tested - single script, mixed script, or whole script - are determined by the check options set for the USpoofChecker.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sc</td><td>The USpoofChecker </td></tr>
<tr><td class="paramname">id1</td><td>The first of the two identifiers to be compared for confusability. The strings are in UTF-8 format. </td></tr>
<tr><td class="paramname">length1</td><td>the length of the first identifiers, in bytes, or -1 if the string is nul terminated. </td></tr>
<tr><td class="paramname">id2</td><td>The second of the two identifiers to be compared for confusability. The strings are in UTF-8 format. </td></tr>
<tr><td class="paramname">length2</td><td>The length of the second string in bytes, or -1 if the string is nul terminated. </td></tr>
<tr><td class="paramname">status</td><td>The error code, set if an error occurred while attempting to perform the check. Confusability of the strings is not reported here, but through this function's return value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An integer value with bit(s) set corresponding to the type of confusability found, as defined by enum USpoofChecks. Zero is returned if the strings are not confusable. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005150">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="aa6628f1b69565e660ecbb1f380ac72dc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t uspoof_check </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td>
<td class="paramname"><em>sc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check the specified string for possible security issues. </p>
<p>The text to be checked will typically be an identifier of some sort. The set of checks to be performed is specified with <a class="el" href="uspoof_8h.html#a1600b90af8fde36cf87d6c6be8df5af0" title="Specify the set of checks that will be performed by the check functions of this Spoof Checker...">uspoof_setChecks()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sc</td><td>The USpoofChecker </td></tr>
<tr><td class="paramname">id</td><td>The identifier to be checked for possible security issues, in UTF-16 format. </td></tr>
<tr><td class="paramname">length</td><td>the length of the string to be checked, expressed in 16 bit UTF-16 code units, or -1 if the string is zero terminated. </td></tr>
<tr><td class="paramname">position</td><td>An out parameter. Originally, the index of the first string position that failed a check. Now, always returns zero. This parameter may be null. </td></tr>
<tr><td class="paramname">status</td><td>The error code, set if an error occurred while attempting to perform the check. Spoofing or security issues detected with the input string are not reported here, but through the function's return value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An integer value with bits set for any potential security or spoofing issues detected. The bits are defined by enum USpoofChecks. (returned_value & USPOOF_ALL_CHECKS) will be zero if the input string passes all of the enabled checks. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005146">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="ab826cb99a2ca41e8030ff55f471a9881"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t uspoof_checkUnicodeString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td>
<td class="paramname"><em>sc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">icu::UnicodeString</a> & </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check the specified string for possible security issues. </p>
<p>The text to be checked will typically be an identifier of some sort. The set of checks to be performed is specified with <a class="el" href="uspoof_8h.html#a1600b90af8fde36cf87d6c6be8df5af0" title="Specify the set of checks that will be performed by the check functions of this Spoof Checker...">uspoof_setChecks()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sc</td><td>The USpoofChecker </td></tr>
<tr><td class="paramname">id</td><td>A identifier to be checked for possible security issues. </td></tr>
<tr><td class="paramname">position</td><td>An out parameter. Originally, the index of the first string position that failed a check. Now, always returns zero. This parameter may be null. </td></tr>
</table>
</dd>
</dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000275">Deprecated:</a></b></dt><dd>ICU 51 <dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>The error code, set if an error occurred while attempting to perform the check. Spoofing or security issues detected with the input string are not reported here, but through the function's return value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An integer value with bits set for any potential security or spoofing issues detected. The bits are defined by enum USpoofChecks. (returned_value & USPOOF_ALL_CHECKS) will be zero if the input string passes all of the enabled checks. </dd></dl>
</dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005148">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="ac3c9dc9db498c19758e4144655919621"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t uspoof_checkUTF8 </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td>
<td class="paramname"><em>sc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check the specified string for possible security issues. </p>
<p>The text to be checked will typically be an identifier of some sort. The set of checks to be performed is specified with <a class="el" href="uspoof_8h.html#a1600b90af8fde36cf87d6c6be8df5af0" title="Specify the set of checks that will be performed by the check functions of this Spoof Checker...">uspoof_setChecks()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sc</td><td>The USpoofChecker </td></tr>
<tr><td class="paramname">id</td><td>A identifier to be checked for possible security issues, in UTF8 format. </td></tr>
<tr><td class="paramname">length</td><td>the length of the string to be checked, or -1 if the string is zero terminated. </td></tr>
<tr><td class="paramname">position</td><td>An out parameter. Originally, the index of the first string position that failed a check. Now, always returns zero. This parameter may be null. </td></tr>
</table>
</dd>
</dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000274">Deprecated:</a></b></dt><dd>ICU 51 <dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>The error code, set if an error occurred while attempting to perform the check. Spoofing or security issues detected with the input string are not reported here, but through the function's return value. If the input contains invalid UTF-8 sequences, a status of U_INVALID_CHAR_FOUND will be returned. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An integer value with bits set for any potential security or spoofing issues detected. The bits are defined by enum USpoofChecks. (returned_value & USPOOF_ALL_CHECKS) will be zero if the input string passes all of the enabled checks. </dd></dl>
</dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005147">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a5a6a3fff21c2aa515d3e16da47609a48"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a>* uspoof_clone </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td>
<td class="paramname"><em>sc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clone a Spoof Checker. </p>
<p>The clone will be set to perform the same checks as the original source.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sc</td><td>The source USpoofChecker </td></tr>
<tr><td class="paramname">status</td><td>The error code, set if this function encounters a problem. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005135">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="ab63b4f7780b1d6c57a31624ad5c3db41"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void uspoof_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td>
<td class="paramname"><em>sc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close a Spoof Checker, freeing any memory that was being held by its implementation. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005134">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="ab15e60d2aaaa9ea5d49eb4524c41fa9e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a>* uspoof_getAllowedChars </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td>
<td class="paramname"><em>sc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a USet for the characters permitted in an identifier. </p>
<p>This corresponds to the limits imposed by the Set Allowed Characters functions. Limitations imposed by other checks will not be reflected in the set returned by this function.</p>
<p>The returned set will be frozen, meaning that it cannot be modified by the caller.</p>
<p>Ownership of the returned set remains with the Spoof Detector. The returned set will become invalid if the spoof detector is closed, or if a new set of allowed characters is specified.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sc</td><td>The USpoofChecker </td></tr>
<tr><td class="paramname">status</td><td>The error code, set if this function encounters a problem. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A USet containing the characters that are permitted by the USPOOF_CHAR_LIMIT test. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005143">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="ae9105b5d6d3dd326dcfd60fe3730f5d0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* uspoof_getAllowedLocales </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td>
<td class="paramname"><em>sc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a list of locales for the scripts that are acceptable in strings to be checked. </p>
<p>If no limitations on scripts have been specified, an empty string will be returned.</p>
<p><a class="el" href="uspoof_8h.html#abe089c3471eb52dbbd7268c3eb9db695" title="Limit the acceptable characters to those specified by a Unicode Set. ">uspoof_setAllowedChars()</a> will reset the list of allowed to be empty.</p>
<p>The format of the returned list is the same as that supplied to <a class="el" href="uspoof_8h.html#aca1b0d0630a88af80c56e8205761f6a1" title="Limit characters that are acceptable in identifiers being checked to those normally used with the lan...">uspoof_setAllowedLocales()</a>, but returned list may not be identical to the originally specified string; the string may be reformatted, and information other than languages from the originally specified locales may be omitted.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sc</td><td>The USpoofChecker </td></tr>
<tr><td class="paramname">status</td><td>The error code, set if this function encounters a problem. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A string containing a list of locales corresponding to the acceptable scripts, formatted like an HTTP Accept Language value.</dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005141">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a882de7faa9049cb6c65f8a949a07a4e9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classicu_1_1UnicodeSet.html">icu::UnicodeSet</a>* uspoof_getAllowedUnicodeSet </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td>
<td class="paramname"><em>sc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a UnicodeSet for the characters permitted in an identifier. </p>
<p>This corresponds to the limits imposed by the Set Allowed Characters / UnicodeSet functions. Limitations imposed by other checks will not be reflected in the set returned by this function.</p>
<p>The returned set will be frozen, meaning that it cannot be modified by the caller.</p>
<p>Ownership of the returned set remains with the Spoof Detector. The returned set will become invalid if the spoof detector is closed, or if a new set of allowed characters is specified.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sc</td><td>The USpoofChecker </td></tr>
<tr><td class="paramname">status</td><td>The error code, set if this function encounters a problem. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A UnicodeSet containing the characters that are permitted by the USPOOF_CHAR_LIMIT test. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005145">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a11c9d7b315c2f4b1011619bd4df91cf8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t uspoof_getChecks </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td>
<td class="paramname"><em>sc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the set of checks that this Spoof Checker has been configured to perform. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sc</td><td>The USpoofChecker </td></tr>
<tr><td class="paramname">status</td><td>The error code, set if this function encounters a problem. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The set of checks that this spoof checker will perform. The value is a bit set, obtained by OR-ing together values from enum USpoofChecks. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005137">Stable:</a></b></dt><dd>ICU 4.2</dd></dl>
</div>
</div>
<a class="anchor" id="a24be9382a3430bbf38abef96f168400b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a>* uspoof_getInclusionSet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the set of Candidate Characters for Inclusion in Identifiers, as defined in Unicode UAX #31, <a href="http://www.unicode.org/reports/tr31/#Table_Candidate_Characters_for_Inclusion_in_Identifiers">http://www.unicode.org/reports/tr31/#Table_Candidate_Characters_for_Inclusion_in_Identifiers</a>. </p>
<p>The returned set is frozen. Ownership of the set remains with the ICU library; it must not be deleted by the caller.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>The error code, set if a problem occurs while creating the set.</td></tr>
</table>
</dd>
</dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000212">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 51 </dd></dl>
</div>
</div>
<a class="anchor" id="a30b3d5dcf1fa794ece93b32608aa803f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classicu_1_1UnicodeSet.html">icu::UnicodeSet</a>* uspoof_getInclusionUnicodeSet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the set of Candidate Characters for Inclusion in Identifiers, as defined in Unicode UAX #31, <a href="http://www.unicode.org/reports/tr31/#Table_Candidate_Characters_for_Inclusion_in_Identifiers">http://www.unicode.org/reports/tr31/#Table_Candidate_Characters_for_Inclusion_in_Identifiers</a>. </p>
<p>The returned set is frozen. Ownership of the set remains with the ICU library; it must not be deleted by the caller.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>The error code, set if a problem occurs while creating the set.</td></tr>
</table>
</dd>
</dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000214">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 51 </dd></dl>
</div>
</div>
<a class="anchor" id="a0eda41b7dffbb123fa62ac1271eee721"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a>* uspoof_getRecommendedSet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the set of characters from Recommended Scripts for Inclusion in Identifiers, as defined in Unicode UAX #31, <a href="http://www.unicode.org/reports/tr31/#Table_Recommended_Scripts">http://www.unicode.org/reports/tr31/#Table_Recommended_Scripts</a>. </p>
<p>The returned set is frozen. Ownership of the set remains with the ICU library; it must not be deleted by the caller.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>The error code, set if a problem occurs while creating the set.</td></tr>
</table>
</dd>
</dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000213">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 51 </dd></dl>
</div>
</div>
<a class="anchor" id="a6693fd20b81ff5adf95b5798fbc818f1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classicu_1_1UnicodeSet.html">icu::UnicodeSet</a>* uspoof_getRecommendedUnicodeSet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the set of characters from Recommended Scripts for Inclusion in Identifiers, as defined in Unicode UAX #31, <a href="http://www.unicode.org/reports/tr31/#Table_Recommended_Scripts">http://www.unicode.org/reports/tr31/#Table_Recommended_Scripts</a>. </p>
<p>The returned set is frozen. Ownership of the set remains with the ICU library; it must not be deleted by the caller.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>The error code, set if a problem occurs while creating the set.</td></tr>
</table>
</dd>
</dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000215">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 51 </dd></dl>
</div>
</div>
<a class="anchor" id="a4d67fe2cfbff34474ad6d85a8135e785"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uspoof_8h.html#a566eea7ea15156355085eb7ff5013852">URestrictionLevel</a> uspoof_getRestrictionLevel </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td>
<td class="paramname"><em>sc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the Restriction Level that will be tested if the checks include RESTRICTION_LEVEL. </p>
<dl class="section return"><dt>Returns</dt><dd>The restriction level </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="uspoof_8h.html#a566eea7ea15156355085eb7ff5013852" title="Constants from UAX #39 for use in setRestrictionLevel(), and for returned identifier restriction leve...">URestrictionLevel</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005139">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</div>
</div>
<a class="anchor" id="ac534ff73614148bad6c93320101f0c47"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t uspoof_getSkeleton </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td>
<td class="paramname"><em>sc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>destCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the "skeleton" for an identifier. </p>
<p>Skeletons are a transformation of the input identifier; Two identifiers are confusable if their skeletons are identical. See Unicode UAX #39 for additional information.</p>
<p>Using skeletons directly makes it possible to quickly check whether an identifier is confusable with any of some large set of existing identifiers, by creating an efficiently searchable collection of the skeletons.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sc</td><td>The USpoofChecker </td></tr>
<tr><td class="paramname">type</td><td>The type of skeleton, corresponding to which of the Unicode confusable data tables to use. The default is Mixed-Script, Lowercase. Allowed options are USPOOF_SINGLE_SCRIPT_CONFUSABLE and USPOOF_ANY_CASE_CONFUSABLE. The two flags may be ORed. </td></tr>
<tr><td class="paramname">id</td><td>The input identifier whose skeleton will be computed. </td></tr>
<tr><td class="paramname">length</td><td>The length of the input identifier, expressed in 16 bit UTF-16 code units, or -1 if the string is zero terminated. </td></tr>
<tr><td class="paramname">dest</td><td>The output buffer, to receive the skeleton string. </td></tr>
<tr><td class="paramname">destCapacity</td><td>The length of the output buffer, in 16 bit units. The destCapacity may be zero, in which case the function will return the actual length of the skeleton. </td></tr>
<tr><td class="paramname">status</td><td>The error code, set if an error occurred while attempting to perform the check. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The length of the skeleton string. The returned length is always that of the complete skeleton, even when the supplied buffer is too small (or of zero length)</dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005152">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="afe14cbde824abd936c704b15e397a015"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="utypes_8h.html#ab9d90a30137b6ec046fe59e79b09745a">U_I18N_API</a> <a class="el" href="classicu_1_1UnicodeString.html">icu::UnicodeString</a>& uspoof_getSkeletonUnicodeString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td>
<td class="paramname"><em>sc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">icu::UnicodeString</a> & </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classicu_1_1UnicodeString.html">icu::UnicodeString</a> & </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the "skeleton" for an identifier. </p>
<p>Skeletons are a transformation of the input identifier; Two identifiers are confusable if their skeletons are identical. See Unicode UAX #39 for additional information.</p>
<p>Using skeletons directly makes it possible to quickly check whether an identifier is confusable with any of some large set of existing identifiers, by creating an efficiently searchable collection of the skeletons.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sc</td><td>The USpoofChecker. </td></tr>
<tr><td class="paramname">type</td><td>The type of skeleton, corresponding to which of the Unicode confusable data tables to use. The default is Mixed-Script, Lowercase. Allowed options are USPOOF_SINGLE_SCRIPT_CONFUSABLE and USPOOF_ANY_CASE_CONFUSABLE. The two flags may be ORed. </td></tr>
<tr><td class="paramname">id</td><td>The input identifier whose skeleton will be computed. </td></tr>
<tr><td class="paramname">dest</td><td>The output identifier, to receive the skeleton string. </td></tr>
<tr><td class="paramname">status</td><td>The error code, set if an error occurred while attempting to perform the check. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the destination (skeleton) string.</dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005154">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a09942c6a49df736928aa5a5c1d329a83"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t uspoof_getSkeletonUTF8 </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td>
<td class="paramname"><em>sc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>destCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the "skeleton" for an identifier. </p>
<p>Skeletons are a transformation of the input identifier; Two identifiers are confusable if their skeletons are identical. See Unicode UAX #39 for additional information.</p>
<p>Using skeletons directly makes it possible to quickly check whether an identifier is confusable with any of some large set of existing identifiers, by creating an efficiently searchable collection of the skeletons.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sc</td><td>The USpoofChecker </td></tr>
<tr><td class="paramname">type</td><td>The type of skeleton, corresponding to which of the Unicode confusable data tables to use. The default is Mixed-Script, Lowercase. Allowed options are USPOOF_SINGLE_SCRIPT_CONFUSABLE and USPOOF_ANY_CASE. The two flags may be ORed. </td></tr>
<tr><td class="paramname">id</td><td>The UTF-8 format identifier whose skeleton will be computed. </td></tr>
<tr><td class="paramname">length</td><td>The length of the input string, in bytes, or -1 if the string is zero terminated. </td></tr>
<tr><td class="paramname">dest</td><td>The output buffer, to receive the skeleton string. </td></tr>
<tr><td class="paramname">destCapacity</td><td>The length of the output buffer, in bytes. The destCapacity may be zero, in which case the function will return the actual length of the skeleton. </td></tr>
<tr><td class="paramname">status</td><td>The error code, set if an error occurred while attempting to perform the check. Possible Errors include U_INVALID_CHAR_FOUND for invalid UTF-8 sequences, and U_BUFFER_OVERFLOW_ERROR if the destination buffer is too small to hold the complete skeleton. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The length of the skeleton string, in bytes. The returned length is always that of the complete skeleton, even when the supplied buffer is too small (or of zero length)</dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005153">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="afeff54ce632c1357e914334009becb62"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a>* uspoof_open </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a Unicode Spoof Checker, configured to perform all checks except for USPOOF_LOCALE_LIMIT and USPOOF_CHAR_LIMIT. </p>
<p>Note that additional checks may be added in the future, resulting in the changes to the default checking behavior.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>The error code, set if this function encounters a problem. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the newly created Spoof Checker </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005131">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="aa13a3dd9f673f9df317948eecab1a346"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a>* uspoof_openFromSerialized </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>pActualLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>pErrorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open a Spoof checker from its serialized from, stored in 32-bit-aligned memory. </p>
<p>Inverse of <a class="el" href="uspoof_8h.html#a808f6fefabd028ea78931f85ec634022" title="Serialize the data for a spoof detector into a chunk of memory. ">uspoof_serialize()</a>. The memory containing the serialized data must remain valid and unchanged as long as the spoof checker, or any cloned copies of the spoof checker, are in use. Ownership of the memory remains with the caller. The spoof checker (and any clones) must be closed prior to deleting the serialized data.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>a pointer to 32-bit-aligned memory containing the serialized form of spoof data </td></tr>
<tr><td class="paramname">length</td><td>the number of bytes available at data; can be more than necessary </td></tr>
<tr><td class="paramname">pActualLength</td><td>receives the actual number of bytes at data taken up by the data; can be NULL </td></tr>
<tr><td class="paramname">pErrorCode</td><td>ICU error code </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the spoof checker.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="uspoof_8h.html#afeff54ce632c1357e914334009becb62" title="Create a Unicode Spoof Checker, configured to perform all checks except for USPOOF_LOCALE_LIMIT and U...">uspoof_open</a> </dd>
<dd>
<a class="el" href="uspoof_8h.html#a808f6fefabd028ea78931f85ec634022" title="Serialize the data for a spoof detector into a chunk of memory. ">uspoof_serialize</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005132">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a5332f41a9d13aec2cc115e6a24d08595"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a>* uspoof_openFromSource </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>confusables</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>confusablesLen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>confusablesWholeScript</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>confusablesWholeScriptLen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>errType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUParseError.html">UParseError</a> * </td>
<td class="paramname"><em>pe</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open a Spoof Checker from the source form of the spoof data. </p>
<p>The Three inputs correspond to the Unicode data files confusables.txt confusablesWholeScript.txt and xidmdifications.txt as described in Unicode UAX #39. The syntax of the source data is as described in UAX #39 for these files, and the content of these files is acceptable input.</p>
<p>The character encoding of the (char *) input text is UTF-8.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">confusables</td><td>a pointer to the confusable characters definitions, as found in file confusables.txt from unicode.org. </td></tr>
<tr><td class="paramname">confusablesLen</td><td>The length of the confusables text, or -1 if the input string is zero terminated. </td></tr>
<tr><td class="paramname">confusablesWholeScript</td><td>a pointer to the whole script confusables definitions, as found in the file confusablesWholeScript.txt from unicode.org. </td></tr>
<tr><td class="paramname">confusablesWholeScriptLen</td><td>The length of the whole script confusables text, or -1 if the input string is zero terminated. </td></tr>
<tr><td class="paramname">errType</td><td>In the event of an error in the input, indicates which of the input files contains the error. The value is one of USPOOF_SINGLE_SCRIPT_CONFUSABLE or USPOOF_WHOLE_SCRIPT_CONFUSABLE, or zero if no errors are found. </td></tr>
<tr><td class="paramname">pe</td><td>In the event of an error in the input, receives the position in the input text (line, offset) of the error. </td></tr>
<tr><td class="paramname">status</td><td>an in/out ICU UErrorCode. Among the possible errors is U_PARSE_ERROR, which is used to report syntax errors in the input. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A spoof checker that uses the rules from the input files. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005133">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a808f6fefabd028ea78931f85ec634022"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t uspoof_serialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td>
<td class="paramname"><em>sc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>capacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Serialize the data for a spoof detector into a chunk of memory. </p>
<p>The flattened spoof detection tables can later be used to efficiently instantiate a new Spoof Detector.</p>
<p>The serialized spoof checker includes only the data compiled from the Unicode data tables by <a class="el" href="uspoof_8h.html#a5332f41a9d13aec2cc115e6a24d08595" title="Open a Spoof Checker from the source form of the spoof data. ">uspoof_openFromSource()</a>; it does not include include any other state or configuration that may have been set.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sc</td><td>the Spoof Detector whose data is to be serialized. </td></tr>
<tr><td class="paramname">data</td><td>a pointer to 32-bit-aligned memory to be filled with the data, can be NULL if capacity==0 </td></tr>
<tr><td class="paramname">capacity</td><td>the number of bytes available at data, or 0 for preflighting </td></tr>
<tr><td class="paramname">status</td><td>an in/out ICU UErrorCode; possible errors include:<ul>
<li>U_BUFFER_OVERFLOW_ERROR if the data storage block is too small for serialization</li>
<li>U_ILLEGAL_ARGUMENT_ERROR the data or capacity parameters are bad </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes written or needed for the spoof data</dd></dl>
<dl class="section see"><dt>See Also</dt><dd>utrie2_openFromSerialized() </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005155">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="abe089c3471eb52dbbd7268c3eb9db695"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void uspoof_setAllowedChars </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td>
<td class="paramname"><em>sc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> * </td>
<td class="paramname"><em>chars</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Limit the acceptable characters to those specified by a Unicode Set. </p>
<p>Any previously specified character limit is is replaced by the new settings. This includes limits on characters that were set with the <a class="el" href="uspoof_8h.html#aca1b0d0630a88af80c56e8205761f6a1" title="Limit characters that are acceptable in identifiers being checked to those normally used with the lan...">uspoof_setAllowedLocales()</a> function.</p>
<p>The USPOOF_CHAR_LIMIT test is automatically enabled for this USpoofChecker by this function.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sc</td><td>The USpoofChecker </td></tr>
<tr><td class="paramname">chars</td><td>A Unicode Set containing the list of characters that are permitted. Ownership of the set remains with the caller. The incoming set is cloned by this function, so there are no restrictions on modifying or deleting the USet after calling this function. </td></tr>
<tr><td class="paramname">status</td><td>The error code, set if this function encounters a problem. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005142">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="aca1b0d0630a88af80c56e8205761f6a1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void uspoof_setAllowedLocales </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td>
<td class="paramname"><em>sc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>localesList</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Limit characters that are acceptable in identifiers being checked to those normally used with the languages associated with the specified locales. </p>
<p>Any previously specified list of locales is replaced by the new settings.</p>
<p>A set of languages is determined from the locale(s), and from those a set of acceptable Unicode scripts is determined. Characters from this set of scripts, along with characters from the "common" and "inherited" Unicode Script categories will be permitted.</p>
<p>Supplying an empty string removes all restrictions; characters from any script will be allowed.</p>
<p>The USPOOF_CHAR_LIMIT test is automatically enabled for this USpoofChecker when calling this function with a non-empty list of locales.</p>
<p>The Unicode Set of characters that will be allowed is accessible via the <a class="el" href="uspoof_8h.html#ab15e60d2aaaa9ea5d49eb4524c41fa9e" title="Get a USet for the characters permitted in an identifier. ">uspoof_getAllowedChars()</a> function. <a class="el" href="uspoof_8h.html#aca1b0d0630a88af80c56e8205761f6a1" title="Limit characters that are acceptable in identifiers being checked to those normally used with the lan...">uspoof_setAllowedLocales()</a> will <em>replace</em> any previously applied set of allowed characters.</p>
<p>Adjustments, such as additions or deletions of certain classes of characters, can be made to the result of <a class="el" href="uspoof_8h.html#aca1b0d0630a88af80c56e8205761f6a1" title="Limit characters that are acceptable in identifiers being checked to those normally used with the lan...">uspoof_setAllowedLocales()</a> by fetching the resulting set with <a class="el" href="uspoof_8h.html#ab15e60d2aaaa9ea5d49eb4524c41fa9e" title="Get a USet for the characters permitted in an identifier. ">uspoof_getAllowedChars()</a>, manipulating it with the Unicode Set API, then resetting the spoof detectors limits with <a class="el" href="uspoof_8h.html#abe089c3471eb52dbbd7268c3eb9db695" title="Limit the acceptable characters to those specified by a Unicode Set. ">uspoof_setAllowedChars()</a></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sc</td><td>The USpoofChecker </td></tr>
<tr><td class="paramname">localesList</td><td>A list list of locales, from which the language and associated script are extracted. The locales are comma-separated if there is more than one. White space may not appear within an individual locale, but is ignored otherwise. The locales are syntactically like those from the HTTP Accept-Language header. If the localesList is empty, no restrictions will be placed on the allowed characters.</td></tr>
<tr><td class="paramname">status</td><td>The error code, set if this function encounters a problem. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005140">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a6193792292d9ead15f9832fcef6a704b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void uspoof_setAllowedUnicodeSet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td>
<td class="paramname"><em>sc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeSet.html">icu::UnicodeSet</a> * </td>
<td class="paramname"><em>chars</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Limit the acceptable characters to those specified by a Unicode Set. </p>
<p>Any previously specified character limit is is replaced by the new settings. This includes limits on characters that were set with the <a class="el" href="uspoof_8h.html#aca1b0d0630a88af80c56e8205761f6a1" title="Limit characters that are acceptable in identifiers being checked to those normally used with the lan...">uspoof_setAllowedLocales()</a> function.</p>
<p>The USPOOF_CHAR_LIMIT test is automatically enabled for this USoofChecker by this function.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sc</td><td>The USpoofChecker </td></tr>
<tr><td class="paramname">chars</td><td>A Unicode Set containing the list of characters that are permitted. Ownership of the set remains with the caller. The incoming set is cloned by this function, so there are no restrictions on modifying or deleting the UnicodeSet after calling this function. </td></tr>
<tr><td class="paramname">status</td><td>The error code, set if this function encounters a problem. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005144">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a1600b90af8fde36cf87d6c6be8df5af0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void uspoof_setChecks </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td>
<td class="paramname"><em>sc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>checks</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Specify the set of checks that will be performed by the check functions of this Spoof Checker. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sc</td><td>The USpoofChecker </td></tr>
<tr><td class="paramname">checks</td><td>The set of checks that this spoof checker will perform. The value is a bit set, obtained by OR-ing together values from enum USpoofChecks. </td></tr>
<tr><td class="paramname">status</td><td>The error code, set if this function encounters a problem. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005136">Stable:</a></b></dt><dd>ICU 4.2</dd></dl>
</div>
</div>
<a class="anchor" id="a27b9d377dbbfa2f8d678a9d3e46b546b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void uspoof_setRestrictionLevel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uspoof_8h.html#ad5e4927218c9e62595a67378cf6e371f">USpoofChecker</a> * </td>
<td class="paramname"><em>sc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="uspoof_8h.html#a566eea7ea15156355085eb7ff5013852">URestrictionLevel</a> </td>
<td class="paramname"><em>restrictionLevel</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the loosest restriction level allowed. </p>
<p>The default if this function is not called is HIGHLY_RESTRICTIVE. Calling this function also enables the RESTRICTION_LEVEL check. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">restrictionLevel</td><td>The loosest restriction level allowed. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="uspoof_8h.html#a566eea7ea15156355085eb7ff5013852" title="Constants from UAX #39 for use in setRestrictionLevel(), and for returned identifier restriction leve...">URestrictionLevel</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005138">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-updates
>
by-pkgid
>
67d6f1fcdf59eeb6f1363fc33c40091c
>
files
>
1401
