InvalidHexData class: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 19: Line 19:




<h2>New constructor</h2>
==New constructor==
{{Template:InvalidHexData:New subtitle}}
{{Template:InvalidHexData:New subtitle}}


Line 26: Line 26:
<h3>Syntax</h3>
<h3>Syntax</h3>
{{Template:InvalidHexData:New syntax}}
{{Template:InvalidHexData:New syntax}}
<h4>Syntax terms</h4>
<h4>Syntax terms</h4>
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%invalidHexData</th>
<tr><th>%invalidHexData</th>
<td>A reference to an instance of an <var>InvalidHexData</var> object.
<td>A reference to an instance of an <var>InvalidHexData</var> object.
</td></tr>
</td></tr>
<tr><th><var>%(InvalidHexData)</var></th><td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>.</td></tr>
 
<tr><th><var>[%(InvalidHexData):]</var></th>
<td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>.</td></tr>
 
<tr><th><var>Position</var></th>
<tr><th><var>Position</var></th>
<td>This [[Methods#Named parameters|name required]] parameter 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>This [[Methods#Named parameters|name required]] parameter 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.
Line 56: Line 61:
The following statements catch an InvalidHexData exception and print its position:
The following statements catch an InvalidHexData exception and print its position:
<p class="code">%target is object invalidhexdata
<p class="code">%target is object invalidhexdata
[[try]] %myobject:mymethod
[[Exceptions#Try and Catch|try]] %myobject:mymethod
   [[catch]] invalidHexData to %target
   catch invalidHexData to %target
   print '%target is ' %target:Position
   print '%target is ' %target:Position
end try
end try

Revision as of 17:54, 7 August 2012


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.

MethodDescription
NewCreate a new InvalidHexData object
PositionInput string position where non-hexadecimal character found

The methods in the class are described in the subsections that follow. In addition:


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 Constructor.
Position This name required parameter 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