InvalidHexData class: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 7: | Line 7: | ||
</p> | </p> | ||
<h2>The InvalidHexData methods</h2> | <h2>The InvalidHexData methods</h2> | ||
{{Template:List of | {{Template:List of InvalidHexData methods}} | ||
The methods in the class are described in the subsections that follow. In addition: | The methods in the class are described in the subsections that follow. In addition: | ||
| Line 14: | Line 15: | ||
<li>[[Notation conventions for methods|"Notation conventions for methods"]] has information | <li>[[Notation conventions for methods|"Notation conventions for methods"]] has information | ||
about the conventions followed. | about the conventions followed. | ||
<li>[[ | <li>[[InvalidHexData methods syntax|"InvalidHexData methods syntax"]] is a single page that contains the syntax diagrams of all the methods in the class. | ||
</ul> | </ul> | ||
| Line 20: | Line 21: | ||
<h2>New constructor</h2> | <h2>New constructor</h2> | ||
{{Template:InvalidHexData:New subtitle}} | {{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. | 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. | ||
| Line 37: | Line 39: | ||
<h2>Position property</h2> | <h2>Position property</h2> | ||
{{Template:InvalidHexData:Position subtitle}} | {{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 | This <var>[[Classes and Objects#readWrite|ReadOnly]]</var> property is the position in the (expected) hexadecimal string where a nonhexadecimal character was found | ||
Revision as of 15:37, 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 InvalidHexData class methods.
| Method | Description |
|---|---|
| New | Create a new InvalidHexData object |
| Position | Input string position where non-hexadecimal 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