View source for JsonParseError class

__NOTOC__
<var>JsonParseError</var> exceptions are typically thrown by the <var>[[Parse (Json function)|Parse]]</var> function in the <var>[[Json class|Json]]</var> class and by the equivalent <var>[[Unicode class|Unicode]]</var> class <var>[[JsonParse (Unicode function)|JsonParse]]</var> function when there is an error parsing JSON data.
 
To create a <var>JsonParseError</var> exception yourself, you typically use a SOUL <var>[[Exceptions#Using the Throw statement|Throw]]</var> statement with a <var>JsonParseError</var> <var>[[New_(JsonParseError_constructor)|New]]</var> constructor. This statement must be issued from within a method, and it can only be caught by the code that calls the method. For example, the following statement throws a <var>JsonParseError</var> exception:
<p class="code">throw %(JsonParseError):new(characterPosition=%pos)
</p>
 
Remember that you catch an exception with the <var>[[Exceptions#Try and Catch|Catch]]</var> statement. If an exception condition occurs outside a <var>Catch</var> for it, the request is canceled.
 
The <var>JsonParseError</var> class, like the <var>Json</var> class is available as of <var class="product">Model 204</var> 7.6.
 
==The JsonParseError methods==
{{Template:List of JsonParseError methods}}
 
The methods in the class are described in the subsections that follow. In addition:
<ul>
<li>[[Notation conventions for methods]] has information
about the conventions followed.</li>

<li>[[JsonParseError methods syntax]] is a single page that contains the syntax diagrams of all the methods in the class.</li>
</ul>

==CharacterPosition property==
{{Template:JsonParseError:CharacterPosition subtitle}}
 
This <var>[[Classes and Objects#readWrite|ReadOnly]]</var> property returns a number that indicates the character position (unicode characters are each two bytes long) in the unicode string being parsed where the error was detected.
 
===Syntax===
{{Template:JsonParseError:CharacterPosition syntax}}

====Syntax terms====
<table>
<tr><th>%number</th>
<td>The character position in the input Unicode string where the parse error was detected.</td></tr>

<tr><th>jsonParseError</th>
<td>A reference to an instance of a <var>[[JsonParseError_class|JsonParseError]]</var> object.</td></tr>
</table>

==Description property==
{{Template:JsonParseError:Description subtitle}}
 
This <var>[[Classes and Objects#readWrite|ReadOnly]]</var> property returns a string that describes the error that was encountered while parsing the JSON data. 

===Syntax===
{{Template:JsonParseError:Description syntax}}

====Syntax terms====
<table>
<tr><th>%string</th>
<td>Text the describes the error that was encountered while parsing JSON data.</td></tr>

<tr><th>jsonParseError</th>
<td>A reference to an instance of a <var>[[JsonParseError class|JsonParseError]]</var> object.</td></tr>
</table>

==New constructor==
{{Template:JsonParseError:New subtitle}}
 
This <var>Constructor</var> generates an instance of a <var>[[JsonParseError_class|JsonParseError]]</var> exception.  

===Syntax===
{{Template:JsonParseError:New syntax}}
 
====Syntax terms====
<table>
<tr><th>%jsonParseError</th><td>A reference to an instance of a <var>JsonParseError</var> object.</td></tr>

<tr><th><var>[%(JsonParseError):]</var></th><td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>.</td></tr>

<tr><th>number</th><td>The character position in the input unicode string where the parse error was detected.</td></tr>

<tr><th>string</th><td>Text that describes the error. It must be 127 characters long or less.</td></tr>
</table>

[[Category:System exception classes]]