InvalidBase64Data class: Difference between revisions
m (yourself) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
<!-- InvalidBase64Data class --> | <!-- InvalidBase64Data class --> | ||
__NOTOC__ | |||
The <var>InvalidBase64Data</var> exception class describes an exception associated with finding non-base64-encoded data where base64-encoded data was expected, usually when decoding base64-encoded data. | The <var>InvalidBase64Data</var> exception class describes an exception associated with finding non-base64-encoded data where base64-encoded data was expected, usually when decoding base64-encoded data. | ||
| Line 6: | Line 7: | ||
</p> | </p> | ||
The methods in | |||
<h2>The InvalidBase64Data methods</h2> | |||
{{Template:List of InvalidBase64Data methods}} | |||
The methods in the class are described in the subsections that follow. In addition: | |||
<ul> | |||
<li>[[Notation conventions for methods|"Notation conventions for methods"]] has information | |||
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. | |||
</ul> | |||
<h2>New constructor</h2> | |||
{{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. | |||
<h4>Syntax</h4> | |||
{{Template:InvalidBase64Data:New syntax}} | |||
<h4>Syntax terms</h4> | |||
<table class="syntaxTable"> | |||
<tr><th>%invalidBase64Data</th> | |||
<td>A reference to an instance of an <var>InvalidBase64Data</var> object. | |||
</td></tr> | |||
<tr><th><var>%(InvalidBase64Data)</var></th><td>The class name in parentheses denotes a shared method.</td></tr> | |||
<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></tr></table> | |||
<h2>Position property</h2> | |||
{{Template:InvalidBase64Data:Position subtitle}} | |||
This <var>[[Classes and Objects#readWrite|ReadOnly]]</var> property returns the position in the (expected) base64-encoded string where a non-base64-encoding character was found. | |||
<h4>Syntax</h4> | |||
{{Template:InvalidBase64Data:Position syntax}} | |||
<h4>Syntax terms</h4> | |||
<table class="syntaxTable"> | |||
<tr><th>%number</th> | |||
<td>This numeric value is the position in the base64 string where a non-base64 character was found. | |||
</td></tr> | |||
<tr><th>invalidBase64Data</th> | |||
<td>A reference to an instance of an <var>InvalidBase64Data</var> object. | |||
</td></tr></table> | |||
[[Category:System exception classes]] | [[Category:System exception classes]] | ||
Revision as of 15:16, 10 May 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.
| Method | Description |
|---|---|
| New | Create a new InvalidBase64Data object |
| Position | Input string position where non-base64 encoding character found |
The methods in the class are described in the subsections that follow. In addition:
- "Notation conventions for methods" has information about the conventions followed.
- "InvalidBase64Data methods syntax" is a single page that contains the syntax diagrams of all the methods in the class.
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 shared method. |
| 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. |