Base64ToString (String function) - Revision history

JAL: /* Usage notes */

2012-11-02T18:35:48Z

Usage notes

← Older revision		Revision as of 18:35, 2 November 2012
Line 22:		Line 22:
	<li>A complete explanation of base64 encoding can be easily found on the internet or in many software textbooks.		<li>A complete explanation of base64 encoding can be easily found on the internet or in many software textbooks.
	<li>The <var>Base64ToString</var> function accepts both the standard base64 encoding (where the encoded string is padded out to an even multiple of four bytes by adding trailing equal signs) and a non-standard encoding (where no trailing equal signs are added and the encoded string might not be an exact multiple of four bytes).		<li>The <var>Base64ToString</var> function accepts both the standard base64 encoding (where the encoded string is padded out to an even multiple of four bytes by adding trailing equal signs) and a non-standard encoding (where no trailing equal signs are added and the encoded string might not be an exact multiple of four bytes).
	<li><var>Base64ToString</var> is available as of <var class="product">[[Sirius Mods~~\|Sirius Mods]]~~</var> version 7.2.		<li><var>Base64ToString</var> is available as of <var class="product">Sirius Mods</var> version 7.2.
	</ul>		</ul>

JAL2 at 20:25, 12 April 2012

2012-04-12T20:25:51Z

← Older revision		Revision as of 20:25, 12 April 2012
Line 8:		Line 8:
	<td>A string variable to receive the unencoded value of the method object <var class="term">string</var>.</td></tr>		<td>A string variable to receive the unencoded value of the method object <var class="term">string</var>.</td></tr>
	<tr><th>string</th>		<tr><th>string</th>
	<td>The input, ~~Base64~~-encoded string value.</td></tr>		<td>The input, base64-encoded string value.</td></tr>
	</table>		</table>

Line 19:		Line 19:

	==Usage notes==		==Usage notes==
	<ul><li>~~Base-64~~ encoding is useful for encoding strings that might contain binary or other characters that could cause problems in certain contexts. For example, binary characters can be problematic when sent in e-mail.<li>~~Base-64~~ encoding is an alternative to hexadecimal encoding. Hexadecimal encoding has the advantage that it's simpler, but it has the disadvantage that it requires two bytes for every encoded byte. ~~Base-64~~ encoding, because it uses more characters (64, as the name would suggest), only requires four bytes for every three encoded bytes.		<ul><li>Base64 encoding is useful for encoding strings that might contain binary or other characters that could cause problems in certain contexts. For example, binary characters can be problematic when sent in e-mail.<li>Base64 encoding is an alternative to hexadecimal encoding. Hexadecimal encoding has the advantage that it's simpler, but it has the disadvantage that it requires two bytes for every encoded byte. Base64 encoding, because it uses more characters (64, as the name would suggest), only requires four bytes for every three encoded bytes.
	<li>A complete explanation of ~~base-64~~ encoding can be easily found on the internet or in many software textbooks.		<li>A complete explanation of base64 encoding can be easily found on the internet or in many software textbooks.
	<li>The <var>Base64ToString</var> function accepts both the standard base64 encoding (where the encoded string is padded out to an even multiple of four bytes by adding trailing equal signs) and a non-standard encoding (where no trailing equal signs are added and the encoded string might not be an exact multiple of four bytes).		<li>The <var>Base64ToString</var> function accepts both the standard base64 encoding (where the encoded string is padded out to an even multiple of four bytes by adding trailing equal signs) and a non-standard encoding (where no trailing equal signs are added and the encoded string might not be an exact multiple of four bytes).
	<li><var>Base64ToString</var> is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> version 7.2.		<li><var>Base64ToString</var> is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> version 7.2.

JAL2 at 01:45, 15 July 2011

2011-07-15T01:45:21Z

← Older revision		Revision as of 01:45, 15 July 2011
Line 1:		Line 1:
	{{Template:String:Base64ToString subtitle}}		{{Template:String:Base64ToString subtitle}}

	~~<var>Base64ToString</var> is and [[Intrinsic classes\|intrinsic]] function returns the unencoded value of a base-64 encoded string.~~

	==Syntax==		==Syntax==
Line 23:		Line 21:
	<ul><li>Base-64 encoding is useful for encoding strings that might contain binary or other characters that could cause problems in certain contexts. For example, binary characters can be problematic when sent in e-mail.<li>Base-64 encoding is an alternative to hexadecimal encoding. Hexadecimal encoding has the advantage that it's simpler, but it has the disadvantage that it requires two bytes for every encoded byte. Base-64 encoding, because it uses more characters (64, as the name would suggest), only requires four bytes for every three encoded bytes.		<ul><li>Base-64 encoding is useful for encoding strings that might contain binary or other characters that could cause problems in certain contexts. For example, binary characters can be problematic when sent in e-mail.<li>Base-64 encoding is an alternative to hexadecimal encoding. Hexadecimal encoding has the advantage that it's simpler, but it has the disadvantage that it requires two bytes for every encoded byte. Base-64 encoding, because it uses more characters (64, as the name would suggest), only requires four bytes for every three encoded bytes.
	<li>A complete explanation of base-64 encoding can be easily found on the internet or in many software textbooks.		<li>A complete explanation of base-64 encoding can be easily found on the internet or in many software textbooks.
	<li>The <var>Base64ToString</var> function accepts both the standard base64 encoding (where the encoded string is padded out to an even multiple of four bytes by adding trailing ~~equals~~ signs) and a non-standard encoding (where no trailing ~~equals~~ signs are added and the encoded string might not be an exact multiple of four bytes).		<li>The <var>Base64ToString</var> function accepts both the standard base64 encoding (where the encoded string is padded out to an even multiple of four bytes by adding trailing equal signs) and a non-standard encoding (where no trailing equal signs are added and the encoded string might not be an exact multiple of four bytes).
	<li><var>Base64ToString</var> is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> version 7.2.		<li><var>Base64ToString</var> is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> version 7.2.
	</ul>		</ul>

	==Examples==		==Examples==
	~~<ol><li>~~The following statement displays <code>Sleeping Bear</code>:		The following statement displays <code>Sleeping Bear</code>:
	<p class="code">[[PrintText statement\|printText]] {'4pOFhZeJlYdAwoWBmQ==':base64toString}		<p class="code">[[PrintText statement\|printText]] {'4pOFhZeJlYdAwoWBmQ==':base64toString}
	</p~~></ol~~>		</p>

	==See also==		==See also==
	<ul><li>The inverse of <var>Base64ToString</var> is <var>[[StringToBase64 (String function)\|StringToBase64]]</var>.</ul>		<ul><li>The inverse of <var>Base64ToString</var> is <var>[[StringToBase64 (String function)\|StringToBase64]]</var>.</ul>
	{{Template:String:Base64ToString footer}}		{{Template:String:Base64ToString footer}}

JALWiccan: 1 revision

2011-05-04T17:46:28Z

1 revision

← Older revision	Revision as of 17:46, 4 May 2011
(No difference)

Goff: printtext

2011-05-04T17:46:25Z

printtext

← Older revision		Revision as of 17:46, 4 May 2011
Line 24:		Line 24:
	<li>A complete explanation of base-64 encoding can be easily found on the internet or in many software textbooks.		<li>A complete explanation of base-64 encoding can be easily found on the internet or in many software textbooks.
	<li>The <var>Base64ToString</var> function accepts both the standard base64 encoding (where the encoded string is padded out to an even multiple of four bytes by adding trailing equals signs) and a non-standard encoding (where no trailing equals signs are added and the encoded string might not be an exact multiple of four bytes).		<li>The <var>Base64ToString</var> function accepts both the standard base64 encoding (where the encoded string is padded out to an even multiple of four bytes by adding trailing equals signs) and a non-standard encoding (where no trailing equals signs are added and the encoded string might not be an exact multiple of four bytes).
	<li><var>Base64ToString</var> is available as of <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> version 7.2.		<li><var>Base64ToString</var> is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> version 7.2.
	</ul>		</ul>

Goff: printtext

2011-02-22T11:17:42Z

printtext

← Older revision		Revision as of 11:17, 22 February 2011
Line 24:		Line 24:
	<li>A complete explanation of base-64 encoding can be easily found on the internet or in many software textbooks.		<li>A complete explanation of base-64 encoding can be easily found on the internet or in many software textbooks.
	<li>The <var>Base64ToString</var> function accepts both the standard base64 encoding (where the encoded string is padded out to an even multiple of four bytes by adding trailing equals signs) and a non-standard encoding (where no trailing equals signs are added and the encoded string might not be an exact multiple of four bytes).		<li>The <var>Base64ToString</var> function accepts both the standard base64 encoding (where the encoded string is padded out to an even multiple of four bytes by adding trailing equals signs) and a non-standard encoding (where no trailing equals signs are added and the encoded string might not be an exact multiple of four bytes).
	<li><var>Base64ToString</var> is available as of <var class="product">Sirius Mods</var> version 7.2.		<li><var>Base64ToString</var> is available as of <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> version 7.2.
	</ul>		</ul>

	==Examples==		==Examples==
	<ol><li>The following statement displays ~~''''~~Sleeping Bear~~''''~~:		<ol><li>The following statement displays <code>Sleeping Bear</code>:
	<p class="code">printText {'4pOFhZeJlYdAwoWBmQ==':base64toString}		<p class="code">[[PrintText statement\|printText]] {'4pOFhZeJlYdAwoWBmQ==':base64toString}
	</p></ol>		</p></ol>

	==See also==		==See also==
	<ul><li>The inverse of <var>Base64ToString</var> is <var>[[StringToBase64 (String function)\|StringToBase64]]</var>.		<ul><li>The inverse of <var>Base64ToString</var> is <var>[[StringToBase64 (String function)\|StringToBase64]]</var>.</ul>
	~~<li>For details of the <var>printtext</var> statement, please see [[Intrinsic classes#printtext\|printText]]~~.</ul>
	{{Template:String:Base64ToString footer}}		{{Template:String:Base64ToString footer}}

Goff: Full stop

2011-02-03T23:15:35Z

Full stop

← Older revision		Revision as of 23:15, 3 February 2011
Line 34:		Line 34:
	==See also==		==See also==
	<ul><li>The inverse of <var>Base64ToString</var> is <var>[[StringToBase64 (String function)\|StringToBase64]]</var>.		<ul><li>The inverse of <var>Base64ToString</var> is <var>[[StringToBase64 (String function)\|StringToBase64]]</var>.
	<li>For details of the <var>printtext</var> statement, please see [[Intrinsic classes#printtext\|printText]]</ul>		<li>For details of the <var>printtext</var> statement, please see [[Intrinsic classes#printtext\|printText]].</ul>
	{{Template:String:Base64ToString footer}}		{{Template:String:Base64ToString footer}}

Goff: re-match syntax diagram to revised template; fix tags. Still some link targets that need to be found / written.

2011-02-02T02:08:46Z

re-match syntax diagram to revised template; fix tags. Still some link targets that need to be found / written.

← Older revision		Revision as of 02:08, 2 February 2011
Line 7:		Line 7:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%~~string~~</th>		<tr><th>%outString</th>
	<td>A string variable to receive the unencoded value of the method object <var class="term">string</var>.</td></tr>		<td>A string variable to receive the unencoded value of the method object <var class="term">string</var>.</td></tr>
	<tr><th~~><var class="term"~~>string~~</var>~~</th>		<tr><th>string</th>
	<td>A Base64-encoded string value.</td></tr>		<td>The input, Base64-encoded string value.</td></tr>
	</table>		</table>

Line 21:		Line 21:

	==Usage notes==		==Usage notes==
	<ul><li>Base-64 encoding is useful for encoding strings that might contain binary or other characters that could cause problems in certain contexts. For example, binary characters can be problematic when sent in e-mail.<p>Base-64 encoding is an alternative to hexadecimal encoding. Hexadecimal encoding has the advantage that it's simpler, but it has the disadvantage that it requires two bytes for every encoded byte. Base-64 encoding, because it uses more characters (64, as the name would suggest), only requires four bytes for every three encoded bytes.~~</p>~~		<ul><li>Base-64 encoding is useful for encoding strings that might contain binary or other characters that could cause problems in certain contexts. For example, binary characters can be problematic when sent in e-mail.<li>Base-64 encoding is an alternative to hexadecimal encoding. Hexadecimal encoding has the advantage that it's simpler, but it has the disadvantage that it requires two bytes for every encoded byte. Base-64 encoding, because it uses more characters (64, as the name would suggest), only requires four bytes for every three encoded bytes.
	<li>A complete explanation of base-64 encoding can be easily found on the internet or in many software textbooks.		<li>A complete explanation of base-64 encoding can be easily found on the internet or in many software textbooks.
	<li>The <var>Base64ToString</var> function accepts both the standard base64 encoding (where the encoded string is padded out to an even multiple of four bytes by adding trailing equals signs) and a non-standard encoding (where no trailing equals signs are added and the encoded string might not be an exact multiple of four bytes).		<li>The <var>Base64ToString</var> function accepts both the standard base64 encoding (where the encoded string is padded out to an even multiple of four bytes by adding trailing equals signs) and a non-standard encoding (where no trailing equals signs are added and the encoded string might not be an exact multiple of four bytes).

Goff: don't link from example

2011-01-31T06:40:14Z

don't link from example

← Older revision		Revision as of 06:40, 31 January 2011
Line 29:		Line 29:
	==Examples==		==Examples==
	<ol><li>The following statement displays ''''Sleeping Bear'''':		<ol><li>The following statement displays ''''Sleeping Bear'''':
	<p class="code">~~[[Intrinsic classes#printtext\|~~printText]] {'4pOFhZeJlYdAwoWBmQ==':base64toString}		<p class="code">printText {'4pOFhZeJlYdAwoWBmQ==':base64toString}
	</p></ol>		</p></ol>

	==See also==		==See also==
	<ul><li>The inverse of <var>Base64ToString</var> is <var>[[StringToBase64 (String function)\|StringToBase64]]</var>.</ul>		<ul><li>The inverse of <var>Base64ToString</var> is <var>[[StringToBase64 (String function)\|StringToBase64]]</var>.
			<li>For details of the <var>printtext</var> statement, please see [[Intrinsic classes#printtext\|printText]]</ul>
	{{Template:String:Base64ToString footer}}		{{Template:String:Base64ToString footer}}

Goff: first pass, match syntax diagram to template and fix tags

2011-01-31T03:24:45Z

first pass, match syntax diagram to template and fix tags

← Older revision		Revision as of 03:24, 31 January 2011
Line 1:		Line 1:
	{{Template:String:Base64ToString subtitle}}		{{Template:String:Base64ToString subtitle}}

	~~This~~ [[Intrinsic classes\|intrinsic]] function returns the unencoded value of a base-64 encoded string.		<var>Base64ToString</var> is and [[Intrinsic classes\|intrinsic]] function returns the unencoded value of a base-64 encoded string.

	~~Base64to<var>String</var> is available as of version 7.2 of the <var class=product>Sirius Mods</var>.~~
	==Syntax==		==Syntax==
	{{Template:String:Base64ToString syntax}}		{{Template:String:Base64ToString syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%~~outStr~~</th>		<tr><th>%string</th>
	<td>A string variable to receive the unencoded value of the method object string. </td></tr>		<td>A string variable to receive the unencoded value of the method object <var class="term">string</var>.</td></tr>
	<tr><th>string</th>		<tr><th><var class="term">string</var></th>
	<td>A Base64-encoded string value.</td></tr>		<td>A Base64-encoded string value.</td></tr>
	</table>		</table>

	===Exceptions===		==Exceptions==
	~~This [[Intrinsic classes\|intrinsic]] function~~ can throw the following exceptions:		<var>Base64ToString</var> can throw the following exceptions:
	<dl>		<dl>
	<dt>[[InvalidBase64data]]		<dt><var>[[InvalidBase64Data class\|InvalidBase64data]]</var>
	<dd>If the method object string does not contain a properly encoded base64		<dd>If the method object string does not contain a properly encoded base64 value. The exception object indicates the position of the first invalid character in the method object string.
	value.
	The exception object indicates the position of the first invalid character
	in the method object string.
	</dl>		</dl>

	==Usage notes==		==Usage notes==
	*Base-64 encoding is useful for encoding strings that might contain		<ul><li>Base-64 encoding is useful for encoding strings that might contain binary or other characters that could cause problems in certain contexts. For example, binary characters can be problematic when sent in e-mail.<p>Base-64 encoding is an alternative to hexadecimal encoding. Hexadecimal encoding has the advantage that it's simpler, but it has the disadvantage that it requires two bytes for every encoded byte. Base-64 encoding, because it uses more characters (64, as the name would suggest), only requires four bytes for every three encoded bytes.</p>
	binary or other characters that could cause problems in certain contexts.		<li>A complete explanation of base-64 encoding can be easily found on the internet or in many software textbooks.
	For example, binary characters can be problematic when sent in e-mail.		<li>The <var>Base64ToString</var> function accepts both the standard base64 encoding (where the encoded string is padded out to an even multiple of four bytes by adding trailing equals signs) and a non-standard encoding (where no trailing equals signs are added and the encoded string might not be an exact multiple of four bytes).
			<li><var>Base64ToString</var> is available as of <var class="product">Sirius Mods</var> version 7.2.
	Base-64 encoding is an alternative to hexadecimal encoding.		</ul>
	Hexadecimal encoding has the advantage that it's simpler, but it has
	the disadvantage that it requires two bytes for every encoded byte.
	Base-64 encoding, because it uses more characters (64, as the name would
	suggest), only requires four bytes for every three encoded bytes.
	*A complete explanation of base-64 encoding can be easily found on the
	internet or in many software textbooks.
	*The ~~Base64to~~<var>~~String~~</var> function accepts both the standard base64 encoding
	(where the encoded string is padded out to an even multiple of four bytes by
	adding trailing equals signs) and a non-standard encoding (where no trailing
	equals signs are added and the encoded string might not be an exact multiple
	of four bytes).
	*The inverse of ~~Base64to~~<var>~~String~~</var> ~~is [[StringToBase64 (String function)\|StringToBase64]]~~.

	==Examples==		==Examples==
			<ol><li>The following statement displays ''''Sleeping Bear'''':
	The following statement displays ''''Sleeping Bear'''':
	<p class="code">[[Intrinsic classes#printtext\|printText]] {'4pOFhZeJlYdAwoWBmQ==':base64toString}		<p class="code">[[Intrinsic classes#printtext\|printText]] {'4pOFhZeJlYdAwoWBmQ==':base64toString}
			</p></ol>

	~~</p>~~
	==See also==		==See also==
			<ul><li>The inverse of <var>Base64ToString</var> is <var>[[StringToBase64 (String function)\|StringToBase64]]</var>.</ul>
	{{Template:String:Base64ToString footer}}		{{Template:String:Base64ToString footer}}