<!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.11"/>
<title>ICU 58.2: UParseError Struct 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="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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ICU 58.2
 <span id="projectnumber">58.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<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 class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">UParseError Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A <a class="el" href="structUParseError.html" title="A UParseError struct is used to returned detailed information about parsing errors. ">UParseError</a> struct is used to returned detailed information about parsing errors.
<a href="structUParseError.html#details">More...</a></p>
<p><code>#include <<a class="el" href="parseerr_8h_source.html">parseerr.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a7e97bc264516d0eecda03609162db2a2"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structUParseError.html#a7e97bc264516d0eecda03609162db2a2">line</a></td></tr>
<tr class="memdesc:a7e97bc264516d0eecda03609162db2a2"><td class="mdescLeft"> </td><td class="mdescRight">The line on which the error occured. <a href="#a7e97bc264516d0eecda03609162db2a2">More...</a><br /></td></tr>
<tr class="separator:a7e97bc264516d0eecda03609162db2a2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa18e9bc2d82bd5a513aa489b32248f69"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structUParseError.html#aa18e9bc2d82bd5a513aa489b32248f69">offset</a></td></tr>
<tr class="memdesc:aa18e9bc2d82bd5a513aa489b32248f69"><td class="mdescLeft"> </td><td class="mdescRight">The character offset to the error. <a href="#aa18e9bc2d82bd5a513aa489b32248f69">More...</a><br /></td></tr>
<tr class="separator:aa18e9bc2d82bd5a513aa489b32248f69"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3f7f2e98b8105346b87170866970c85a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structUParseError.html#a3f7f2e98b8105346b87170866970c85a">preContext</a> [U_PARSE_CONTEXT_LEN]</td></tr>
<tr class="memdesc:a3f7f2e98b8105346b87170866970c85a"><td class="mdescLeft"> </td><td class="mdescRight">Textual context before the error. <a href="#a3f7f2e98b8105346b87170866970c85a">More...</a><br /></td></tr>
<tr class="separator:a3f7f2e98b8105346b87170866970c85a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1076f681e0c1fcec4bf0ff28703b9aea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structUParseError.html#a1076f681e0c1fcec4bf0ff28703b9aea">postContext</a> [U_PARSE_CONTEXT_LEN]</td></tr>
<tr class="memdesc:a1076f681e0c1fcec4bf0ff28703b9aea"><td class="mdescLeft"> </td><td class="mdescRight">The error itself and/or textual context after the error. <a href="#a1076f681e0c1fcec4bf0ff28703b9aea">More...</a><br /></td></tr>
<tr class="separator:a1076f681e0c1fcec4bf0ff28703b9aea"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A <a class="el" href="structUParseError.html" title="A UParseError struct is used to returned detailed information about parsing errors. ">UParseError</a> struct is used to returned detailed information about parsing errors. </p>
<p>It is used by ICU parsing engines that parse long rules, patterns, or programs, where the text being parsed is long enough that more information than a UErrorCode is needed to localize the error.</p>
<p>The line, offset, and context fields are optional; parsing engines may choose not to use to use them.</p>
<p>The preContext and postContext strings include some part of the context surrounding the error. If the source text is "let for=7" and "for" is the error (e.g., because it is a reserved word), then some examples of what a parser might produce are the following:</p>
<pre>
preContext postContext
"" "" The parser does not support context
"let " "=7" Pre- and post-context only
"let " "for=7" Pre- and post-context and error text
"" "for" Error text only
</pre><p>Examples of engines which use <a class="el" href="structUParseError.html" title="A UParseError struct is used to returned detailed information about parsing errors. ">UParseError</a> (or may use it in the future) are Transliterator, RuleBasedBreakIterator, and RegexPattern.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000450">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="parseerr_8h_source.html#l00058">58</a> of file <a class="el" href="parseerr_8h_source.html">parseerr.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a7e97bc264516d0eecda03609162db2a2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t UParseError::line</td>
</tr>
</table>
</div><div class="memdoc">
<p>The line on which the error occured. </p>
<p>If the parser uses this field, it sets it to the line number of the source text line on which the error appears, which will be be a value >= 1. If the parse does not support line numbers, the value will be <= 0. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable000451">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="parseerr_8h_source.html#l00067">67</a> of file <a class="el" href="parseerr_8h_source.html">parseerr.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa18e9bc2d82bd5a513aa489b32248f69"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t UParseError::offset</td>
</tr>
</table>
</div><div class="memdoc">
<p>The character offset to the error. </p>
<p>If the line field is >= 1, then this is the offset from the start of the line. Otherwise, this is the offset from the start of the text. If the parser does not support this field, it will have a value < 0. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable000452">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="parseerr_8h_source.html#l00076">76</a> of file <a class="el" href="parseerr_8h_source.html">parseerr.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1076f681e0c1fcec4bf0ff28703b9aea"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> UParseError::postContext[U_PARSE_CONTEXT_LEN]</td>
</tr>
</table>
</div><div class="memdoc">
<p>The error itself and/or textual context after the error. </p>
<p>Null-terminated. The empty string if not supported by parser. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable000454">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="parseerr_8h_source.html#l00090">90</a> of file <a class="el" href="parseerr_8h_source.html">parseerr.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3f7f2e98b8105346b87170866970c85a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> UParseError::preContext[U_PARSE_CONTEXT_LEN]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Textual context before the error. </p>
<p>Null-terminated. The empty string if not supported by parser. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable000453">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="parseerr_8h_source.html#l00083">83</a> of file <a class="el" href="parseerr_8h_source.html">parseerr.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="parseerr_8h_source.html">parseerr.h</a></li>
</ul>
</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.11
</small></address>
</body>
</html>
distrib
>
Mageia
>
6
>
armv5tl
>
media
>
core-release
>
by-pkgid
>
3a4e91bde08970529a0aa07935652fe8
>
files
>
881
