InvalidHexData class: Difference between revisions
m (tags and edits) |
mNo edit summary |
||
Line 1: | Line 1: | ||
<!-- InvalidHexData class --> | <!-- InvalidHexData class --> | ||
__NOTOC__ | |||
The <var>InvalidHexData</var> exception class describes an exception associated with finding non-hexadecimal data where hexadecimal data was expected, usually when translating the hexadecimal data to something else. | The <var>InvalidHexData</var> exception class describes an exception associated with finding non-hexadecimal data where hexadecimal data was expected, usually when translating the hexadecimal data to something else. | ||
Line 6: | Line 7: | ||
</p> | </p> | ||
The methods in | <h2>The InvalidHexData methods</h2> | ||
{{Template:List of InvalidBase64Data methods}} | |||
The methods in the class are described in the subsections that follow. In addition: | |||
<ul> | |||
<li>[[Notation conventions for methods|"Notation conventions for methods"]] has information | |||
about the conventions followed. | |||
<li>[[InvalidBHexData methods syntax|"InvalidHexData methods syntax"]] is a single page that contains the syntax diagrams of all the methods in the class. | |||
</ul> | |||
<h2>New constructor</h2> | |||
{{Template:InvalidHexData:New subtitle}} | |||
This constructor generates an instance of an <var>[[InvalidHexData_class|InvalidHexData]]</var> exception. As shown below, the required argument of the <var>New</var> method is a setting of the <var>[[Position_(InvalidHexData_property)|Position]]</var> property. | |||
<h4>Syntax</h4> | |||
{{Template:InvalidHexData:New syntax}} | |||
<h4>Syntax terms</h4> | |||
<table class="syntaxTable"> | |||
<tr><th>%invalidHexData</th> | |||
<td>A reference to an instance of an <var>InvalidHexData</var> object. | |||
</td></tr> | |||
<tr><th><var>%(InvalidHexData)</var></th><td>The class name in parentheses denotes a shared method.</td></tr> | |||
<tr><th><var>Position</var></th> | |||
<td>This [[Methods#Named parameters|name required]] parameter: <var>Position</var>, specifies the numeric value (<var class="term">number</var>) for the position to be assigned to the <var>InvalidHexData</var> exception object's <var>[[Position_(InvalidHexData_property)|Position]]</var> property when a data error is encountered. | |||
</td></tr></table> | |||
<h2>Position property</h2> | |||
{{Template:InvalidHexData:Position subtitle}} | |||
This <var>[[Classes and Objects#readWrite|ReadOnly]]</var> property is the position in the (expected) hexadecimal string where a nonhexadecimal character was found | |||
<h4>Syntax</h4> | |||
{{Template:InvalidHexData:Position syntax}} | |||
<h4>Syntax terms</h4> | |||
<table class="syntaxTable"> | |||
<tr><th>%number</th> | |||
<td>This numeric value is the position in the hexadecimal string where a non-hexadecimal character was found. <var class="term">%number</var> will be <code>0</code> (zero) if the exception was caused because the method object string contained an odd number of characters. | |||
</td></tr> | |||
<tr><th>invalidHexData</th> | |||
<td>A reference to an instance of an <var>[[InvalidHexData_class|InvalidHexData]]</var> object. | |||
</td></tr></table> | |||
==Example== | |||
The following statements catch an InvalidHexData exception and print its position: | |||
<p class="code">%target is object invalidhexdata | |||
[[try]] %myobject:mymethod | |||
[[catch]] invalidHexData to %target | |||
print '%target is ' %target:Position | |||
end try | |||
</p> | |||
[[Category:System exception classes]] | [[Category:System exception classes]] |
Revision as of 15:34, 10 May 2011
The InvalidHexData exception class describes an exception associated with finding non-hexadecimal data where hexadecimal data was expected, usually when translating the hexadecimal data to something else.
To produce an InvalidHexData exception yourself, you typically use a User Language Throw statement with an InvalidHexData New 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 an InvalidHexData exception with the position set to 1
:
throw %(invalidHexData):new(position=1)
The InvalidHexData methods
The following are the available InvalidBase64Data class methods.
Method | Description |
---|---|
New | Create a new InvalidBase64Data object |
Position | Input string position where non-base64 encoding character found |
The methods in the class are described in the subsections that follow. In addition:
- "Notation conventions for methods" has information about the conventions followed.
- "InvalidHexData methods syntax" is a single page that contains the syntax diagrams of all the methods in the class.
New constructor
Create a new InvalidHexData object (InvalidHexData class) This constructor generates an instance of an InvalidHexData exception. As shown below, the required argument of the New method is a setting of the Position property.
Syntax
%invalidHexData = [%(InvalidHexData):]New( Position= number)
Syntax terms
%invalidHexData | A reference to an instance of an InvalidHexData object. |
---|---|
%(InvalidHexData) | The class name in parentheses denotes a shared method. |
Position | This name required parameter: Position, specifies the numeric value (number) for the position to be assigned to the InvalidHexData exception object's Position property when a data error is encountered. |
Position property
Input string position where non-hexadecimal character found (InvalidHexData class) This ReadOnly property is the position in the (expected) hexadecimal string where a nonhexadecimal character was found
Syntax
%number = invalidHexData:Position
Syntax terms
%number | This numeric value is the position in the hexadecimal string where a non-hexadecimal character was found. %number will be 0 (zero) if the exception was caused because the method object string contained an odd number of characters.
|
---|---|
invalidHexData | A reference to an instance of an InvalidHexData object. |
Example
The following statements catch an InvalidHexData exception and print its position:
%target is object invalidhexdata try %myobject:mymethod catch invalidHexData to %target print '%target is ' %target:Position end try