New (CharacterTranslationException constructor)

From m204wiki
Revision as of 23:31, 2 March 2011 by JAL (talk | contribs)
Jump to navigation Jump to search

<section begin=dpl_desc/>Create new CharacterTranslationException instance<section end=dpl_desc/>

New is a member of the CharacterTranslationException class.

This constructor generates an instance of a CharacterTranslationException exception. As shown in the syntax that follows, the New method arguments set the values of the properties of the class that have the corresponding names.

Syntax

[%chTransEx =] [(CharacterTranslationException):] - New ( Reason = reasonEnum, - [, BytePosition = num] - [, CharacterPosition = num] - [, Description = string] - [, HexValue = string] )

Syntax terms

%chTransEx A reference to an instance of a CharacterTranslationException object.
Reason=reasonEnum This name required parameter specifies the value to be assigned to the exception object's Reason property. As described in for the Reason property, the reasonEnum enumeration values are InvalidEncoding, InvalidCharacterReference, and UntranslatableCharacter.

The Reason parameter is not optional.

BytePosition=num This name required parameter specifies the numeric value (num) to be assigned to the object's BytePosition property.
CharacterPosition=num This name required parameter specifies the numeric value (num) to be assigned to the object's CharacterPosition property.
Description=string This name required parameter specifies the string value (string) to be assigned to the object's Description property.
HexValue=string This name required parameter specifies the string value (string) to be assigned to the object's HexValue property.