InvalidBase64Data class: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 22: Line 22:
{{Template:InvalidBase64Data:New subtitle}}
{{Template:InvalidBase64Data:New subtitle}}


This constructor generates an instance of an <var>[[InvalidBase64Data_class|InvalidBase64Data]]</var> exception.  As shown below, the required argument of the <var>New</var> method is a setting of the <var>[[Position_(InvalidBase64Data_property)|Position]]</var> property.
This <var>Constructor</var> generates an instance of an <var>[[InvalidBase64Data_class|InvalidBase64Data]]</var> exception.  As shown below, the required argument of the <var>New</var> method is a setting of the <var>[[Position_(InvalidBase64Data_property)|Position]]</var> property.


<h3>Syntax</h3>
<h3>Syntax</h3>
Line 31: Line 31:
<td>A reference to an instance of an <var>InvalidBase64Data</var> object.
<td>A reference to an instance of an <var>InvalidBase64Data</var> object.
</td></tr>
</td></tr>
<tr><th><var>%(InvalidBase64Data)</var></th><td>The class name in parentheses denotes a shared method.</td></tr>
<tr><th><var>%(InvalidBase64Data)</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: <var>Position</var>, specifies the numeric value (<var class="term">number</var>) for the position to be assigned to the <var>InvalidBase64Data</var> exception object's <var>Position</var> property when a data error is encountered.
<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>InvalidBase64Data</var> exception object's <var>Position</var> property when a data error is encountered.

Revision as of 20:55, 27 July 2011


The InvalidBase64Data exception class describes an exception associated with finding non-base64-encoded data where base64-encoded data was expected, usually when decoding base64-encoded data.

To produce an InvalidBase64Data exception yourself, you typically use a User Language Throw statement with an InvalidBase64Data 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 InvalidBase64Data exception with the position set to 2:

throw %(invalidBase64Data):new(position=2)


The InvalidBase64Data methods

The following are the available InvalidBase64Data class methods.

MethodDescription
NewCreate a new InvalidBase64Data object
PositionInput string position where non-base64 encoding character found

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


New constructor

Create a new InvalidBase64Data object (InvalidBase64Data class)

This Constructor generates an instance of an InvalidBase64Data exception. As shown below, the required argument of the New method is a setting of the Position property.

Syntax

%invalidBase64Data = [%(InvalidBase64Data):]New( Position= number)

Syntax terms

%invalidBase64Data A reference to an instance of an InvalidBase64Data object.
%(InvalidBase64Data)The class name in parentheses denotes a Constructor.
Position This name required parameter: Position, specifies the numeric value (number) for the position to be assigned to the InvalidBase64Data exception object's Position property when a data error is encountered.


Position property

Input string position where non-base64 encoding character found (InvalidBase64Data class)

This ReadOnly property returns the position in the (expected) base64-encoded string where a non-base64-encoding character was found.

Syntax

%number = invalidBase64Data:Position

Syntax terms

%number This numeric value is the position in the base64 string where a non-base64 character was found.
invalidBase64Data A reference to an instance of an InvalidBase64Data object.