InvalidBase64Data class: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
 
m (link repair)
 
Line 13: Line 13:
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:
<ul>
<ul>
<li>[[Notation conventions for methods|"Notation conventions for methods"]] has information
<li>[[Notation conventions for methods]] has information about the conventions followed. </li>
about the conventions followed.  


<li>[[InvalidBase64Data methods syntax|"InvalidBase64Data methods syntax"]] is a single page that contains the syntax diagrams of all the methods in the class.
<li>[[InvalidBase64Data methods syntax]] is a single page that contains the syntax diagrams of all the methods in the class. </li>
</ul>
</ul>


Line 29: Line 28:


====Syntax terms====
====Syntax terms====
<table class="syntaxTable">
<table>
 
<tr><th>%invalidBase64Data</th>
<tr><th>%invalidBase64Data</th>
<td>A reference to an instance of an <var>InvalidBase64Data</var> object.
<td>A reference to an instance of an <var>InvalidBase64Data</var> object.
Line 49: Line 47:
===Syntax===
===Syntax===
{{Template:InvalidBase64Data:Position syntax}}
{{Template:InvalidBase64Data:Position syntax}}
====Syntax terms====
====Syntax terms====
<table class="syntaxTable">
<table>
<tr><th>%number</th>
<tr><th>%number</th>
<td>This numeric value is the position in the base64 string where a non-base64 character was found.
<td>This numeric value is the position in the base64 string where a non-base64 character was found.
</td></tr>
</td></tr>
<tr><th>invalidBase64Data</th>
<tr><th>invalidBase64Data</th>
<td>A reference to an instance of an <var>InvalidBase64Data</var> object.
<td>A reference to an instance of an <var>InvalidBase64Data</var> object.

Latest revision as of 22:20, 18 November 2014


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.