New (CharacterTranslationException constructor): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
m (→Syntax terms) |
||
| Line 8: | Line 8: | ||
<td>A reference to the newly created instance of a <var>[[CharacterTranslationException_class|CharacterTranslationException]]</var> object. | <td>A reference to the newly created instance of a <var>[[CharacterTranslationException_class|CharacterTranslationException]]</var> object. | ||
</td></tr> | </td></tr> | ||
<tr><th>Reason</th> | <tr><th><var>Reason</var></th> | ||
<td><var>Reason</var> is a <b><i>non-</i></b>optional, [[Methods#Named parameters|name required]] parameter specifying the value to be assigned to the exception object's <var>[[Reason (CharacterTranslationException property)|Reason]]</var> property. | <td><var>Reason</var> is a <b><i>non-</i></b>optional, [[Methods#Named parameters|name required]] parameter specifying the value to be assigned to the exception object's <var>[[Reason (CharacterTranslationException property)|Reason]]</var> property. | ||
<p>As described in for the <var>[[Reason_(CharacterTranslationException_property)#Usage_notes|Reason]]</var> property, the <var>translationExceptionReason</var> enumeration values are <code>InvalidEncoding</code>, <code>InvalidCharacterReference</code>, and <code>UntranslatableCharacter</code>.</p></td></tr> | <p>As described in for the <var>[[Reason_(CharacterTranslationException_property)#Usage_notes|Reason]]</var> property, the <var>translationExceptionReason</var> enumeration values are <code>InvalidEncoding</code>, <code>InvalidCharacterReference</code>, and <code>UntranslatableCharacter</code>.</p></td></tr> | ||
<tr><th>HexValue</th> | <tr><th><var>HexValue</var></th> | ||
<td>This <var>name-required</var> parameter specifies the string value (<var class="term">%string</var>) to be assigned to the object's <var class="term">[[HexValue_(CharacterTranslationException_property)|HexValue]]</var> property. | <td>This <var>name-required</var> parameter specifies the string value (<var class="term">%string</var>) to be assigned to the object's <var class="term">[[HexValue_(CharacterTranslationException_property)|HexValue]]</var> property. | ||
</td></tr> | </td></tr> | ||
<tr><th>BytePosition</th> | <tr><th><var>BytePosition</var></th> | ||
<td>This <var>name-required</var> parameter specifies the numeric value (<var class="term">%number</var>) to be assigned to the object's <var class="term">[[BytePosition_(CharacterTranslationException_property)|BytePosition]]</var> property. | <td>This <var>name-required</var> parameter specifies the numeric value (<var class="term">%number</var>) to be assigned to the object's <var class="term">[[BytePosition_(CharacterTranslationException_property)|BytePosition]]</var> property. | ||
</td></tr> | </td></tr> | ||
<tr><th>CharacterPosition</th> | <tr><th><var>CharacterPosition</var></th> | ||
<td>This <var>name-required</var> parameter specifies the numeric value (<var class="term">%number</var>) to be assigned to the object's <var class="term">[[CharacterPosition_(CharacterTranslationException_property)|CharacterPosition]]</var> property. | <td>This <var>name-required</var> parameter specifies the numeric value (<var class="term">%number</var>) to be assigned to the object's <var class="term">[[CharacterPosition_(CharacterTranslationException_property)|CharacterPosition]]</var> property. | ||
</td></tr> | </td></tr> | ||
<tr><th>Description</th> | <tr><th><var>Description</var></th> | ||
<td>This <var>name-required</var> parameter specifies the string value (<var class="term">%string</var>) to be assigned to the object's <var class="term">[[Description_(CharacterTranslationException_property)|Description]]</var> property. | <td>This <var>name-required</var> parameter specifies the string value (<var class="term">%string</var>) to be assigned to the object's <var class="term">[[Description_(CharacterTranslationException_property)|Description]]</var> property. | ||
</td></tr> | </td></tr> | ||
Revision as of 22:32, 4 May 2011
Create a new CharacterTranslationException object (CharacterTranslationException class) Each argument to New sets the value of the corresponding property of the newly constructed CharacterTranslationException object.
Syntax
%characterTranslationException = [%(CharacterTranslationException):]New( Reason= translationExceptionReason, - [HexValue= string], - [BytePosition= number], - [CharacterPosition= number], - [Description= string])
Syntax terms
| %characterTranslationException | A reference to the newly created instance of a CharacterTranslationException object. |
|---|---|
| Reason | Reason is a non-optional, name required parameter specifying the value to be assigned to the exception object's Reason property.
As described in for the Reason property, the translationExceptionReason enumeration values are |
| HexValue | This name-required parameter specifies the string value (%string) to be assigned to the object's HexValue property. |
| BytePosition | This name-required parameter specifies the numeric value (%number) to be assigned to the object's BytePosition property. |
| CharacterPosition | This name-required parameter specifies the numeric value (%number) to be assigned to the object's CharacterPosition property. |
| Description | This name-required parameter specifies the string value (%string) to be assigned to the object's Description property. |