HexToString (String function) - Revision history

JAL: /* Examples */

2012-11-02T20:58:33Z

Examples

← Older revision		Revision as of 20:58, 2 November 2012
Line 34:		Line 34:
	<p class="code">[[PrintText statement\|printText]] {'E2818995A340D481998985':hexToString}		<p class="code">[[PrintText statement\|printText]] {'E2818995A340D481998985':hexToString}
	</p>		</p>
	<li>The following statement displays <code>??</code>' because no displayable characters exist for the specified hex values:		<li>The following statement displays <code>??</code> because no displayable characters exist for the specified hex values:
	<p class="code">printText {'FFFE':hexToString(signed=true)}		<p class="code">printText {'FFFE':hexToString(signed=true)}
	</p>		</p>

JAL: /* Usage notes */

2012-11-02T20:57:58Z

Usage notes

← Older revision		Revision as of 20:57, 2 November 2012
Line 27:		Line 27:
	Hex (short for hexadecimal) encoding is usually used for debugging when there is a concern that non-displayable characters (including trailing blanks) might be present in a string. By hex-encoding such a string, all non-displayable bytes are converted to displayable hexadecimal equivalents.		Hex (short for hexadecimal) encoding is usually used for debugging when there is a concern that non-displayable characters (including trailing blanks) might be present in a string. By hex-encoding such a string, all non-displayable bytes are converted to displayable hexadecimal equivalents.
	<li><var>HexToString</var> requires a method object string with an even number of bytes.		<li><var>HexToString</var> requires a method object string with an even number of bytes.
	<li><var>HexToString</var> displays a question mark (<~~code~~>?</~~code~~>) in cases where a converted hex value has no displayable character representation.		<li><var>HexToString</var> displays a question mark (<tt>?</tt>) in cases where a converted hex value has no displayable character representation.
	<li><var>HexToString</var> is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> version 7.2.</ul>		<li><var>HexToString</var> is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> version 7.2.</ul>

JALWiccan: 1 revision

2011-05-04T17:46:29Z

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 28:		Line 28:
	<li><var>HexToString</var> requires a method object string with an even number of bytes.		<li><var>HexToString</var> requires a method object string with an even number of bytes.
	<li><var>HexToString</var> displays a question mark (<code>?</code>) in cases where a converted hex value has no displayable character representation.		<li><var>HexToString</var> displays a question mark (<code>?</code>) in cases where a converted hex value has no displayable character representation.
	<li><var>HexToString</var> is available as of <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> version 7.2.</ul>		<li><var>HexToString</var> is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> version 7.2.</ul>

	==Examples==		==Examples==

Goff: printtext

2011-02-22T11:38:13Z

printtext

← Older revision		Revision as of 11:38, 22 February 2011
Line 28:		Line 28:
	<li><var>HexToString</var> requires a method object string with an even number of bytes.		<li><var>HexToString</var> requires a method object string with an even number of bytes.
	<li><var>HexToString</var> displays a question mark (<code>?</code>) in cases where a converted hex value has no displayable character representation.		<li><var>HexToString</var> displays a question mark (<code>?</code>) in cases where a converted hex value has no displayable character representation.
	<li><var>HexToString</var> is available as of <var class="product">Sirius Mods</var> version 7.2.</ul>		<li><var>HexToString</var> is available as of <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> version 7.2.</ul>

	==Examples==		==Examples==
	<ol><li>The following statement displays <code>Saint Marie</code>:		<ol><li>The following statement displays <code>Saint Marie</code>:
	<p class="code">printText {'E2818995A340D481998985':hexToString}		<p class="code">[[PrintText statement\|printText]] {'E2818995A340D481998985':hexToString}
	</p>		</p>
	<li>The following statement displays <code>??</code>' because no displayable characters exist for the specified hex values:		<li>The following statement displays <code>??</code>' because no displayable characters exist for the specified hex values:
Line 41:		Line 41:
	==See also==		==See also==
	<ul><li>[[X (String function)\|X]] is a compile-time only equivalent of the <var>HexToString</var> method.		<ul><li>[[X (String function)\|X]] is a compile-time only equivalent of the <var>HexToString</var> method.
	<li>The inverse of <var>HexToString</var> is <var>[[StringToHex (String function)\|StringToHex~~]]</var>.~~		<li>The inverse of <var>HexToString</var> is <var>[[StringToHex (String function)\|StringToHex]]</var>.</ul>
	~~<li>For details of the <var>printtext</var> statement, please see <var>[[Intrinsic classes#printtext\|printText~~]]</var>.</ul>
	{{Template:String:HexToString footer}}		{{Template:String:HexToString footer}}

Goff: Full stop

2011-02-03T23:21:56Z

Full stop

← Older revision		Revision as of 23:21, 3 February 2011
Line 42:		Line 42:
	<ul><li>[[X (String function)\|X]] is a compile-time only equivalent of the <var>HexToString</var> method.		<ul><li>[[X (String function)\|X]] is a compile-time only equivalent of the <var>HexToString</var> method.
	<li>The inverse of <var>HexToString</var> is <var>[[StringToHex (String function)\|StringToHex]]</var>.		<li>The inverse of <var>HexToString</var> is <var>[[StringToHex (String function)\|StringToHex]]</var>.
	<li>For details of the <var>printtext</var> statement, please see <var>[[Intrinsic classes#printtext\|printText]]</var>~~</ul>~~</ul>		<li>For details of the <var>printtext</var> statement, please see <var>[[Intrinsic classes#printtext\|printText]]</var>.</ul>
	{{Template:String:HexToString footer}}		{{Template:String:HexToString footer}}

Goff: re-match syntax diagram to revised template; fix tags.

2011-02-02T03:08:42Z

re-match syntax diagram to revised template; fix tags.

← Older revision		Revision as of 03: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 hex-encoded string value.</td></tr>		<td>A hex-encoded string value.</td></tr>
	</table>		</table>
Line 32:		Line 32:
	==Examples==		==Examples==
	<ol><li>The following statement displays <code>Saint Marie</code>:		<ol><li>The following statement displays <code>Saint Marie</code>:
	<p class="code">~~[[Intrinsic classes#printtext\|~~printText]] {'E2818995A340D481998985':hexToString}		<p class="code">printText {'E2818995A340D481998985':hexToString}
	</p>		</p>
	<li>The following statement displays <code>??</code>' because no displayable characters exist for the specified hex values:		<li>The following statement displays <code>??</code>' because no displayable characters exist for the specified hex values:
Line 41:		Line 41:
	==See also==		==See also==
	<ul><li>[[X (String function)\|X]] is a compile-time only equivalent of the <var>HexToString</var> method.		<ul><li>[[X (String function)\|X]] is a compile-time only equivalent of the <var>HexToString</var> method.
	<li>The inverse of <var>HexToString</var> is <var>[[StringToHex (String function)\|StringToHex]]</var>.</ul>		<li>The inverse of <var>HexToString</var> is <var>[[StringToHex (String function)\|StringToHex]]</var>.
			<li>For details of the <var>printtext</var> statement, please see <var>[[Intrinsic classes#printtext\|printText]]</var></ul></ul>
	{{Template:String:HexToString footer}}		{{Template:String:HexToString footer}}

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

2011-01-31T06:19:29Z

first pass, match syntax diagram to template and fix tags

← Older revision		Revision as of 06:19, 31 January 2011
Line 1:		Line 1:
	{{Template:String:HexToString subtitle}}		{{Template:String:HexToString subtitle}}

	~~This~~ [[Intrinsic classes\|intrinsic]] function returns the unencoded value of a hex encoded string.		<var>HexToString</var> is an [[Intrinsic classes\|intrinsic]] function that returns the unencoded value of a hex encoded string.

	~~<var>HexToString</var> is available as of version 7.2 of the <var class=product>Sirius Mods</var>.~~
	==Syntax==		==Syntax==
	{{Template:String:HexToString syntax}}		{{Template:String:HexToString 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 hex-encoded string value.</td></tr>		<td>A hex-encoded string value.</td></tr>
	</table>		</table>

	===Exceptions===		==Exceptions==

	This [[Intrinsic classes\|intrinsic]] function can throw the following exceptions:		This [[Intrinsic classes\|intrinsic]] function can throw the following exceptions:
	<dl>		<dl>
	<dt>[[InvalidHexData]]		<dt><var>[[InvalidHexData class\|InvalidHexData]]</var>
	<dd>If the method object string does not contain a properly encoded hexadecimal value.		<dd>If the method object string does not contain a properly encoded hexadecimal value.
	The exception object indicates the position of the first invalid character		The exception object indicates the position of the first invalid character
Line 24:		Line 22:
	string had an odd number of characters.		string had an odd number of characters.
	</dl>		</dl>

	==Usage notes==		==Usage notes==
	*Hex (short for hexadecimal) encoding is usually used for debugging when there is a concern that non-displayable characters (including trailing blanks) might be present in a string. By hex-encoding such a string, all non-displayable bytes are converted to displayable hexadecimal equivalents.		<ul><li>
	*The <var>HexToString</var> ~~function~~ requires a method object string with an even number of bytes.		Hex (short for hexadecimal) encoding is usually used for debugging when there is a concern that non-displayable characters (including trailing blanks) might be present in a string. By hex-encoding such a string, all non-displayable bytes are converted to displayable hexadecimal equivalents.
	*<var>HexToString</var> displays a question mark (~~''''~~?~~''''~~) in ~~a case~~ where a converted hex value has no displayable character representation.		<li><var>HexToString</var> requires a method object string with an even number of bytes.
	*The [[X (String function)\|X]] function is a compile-time only equivalent of the <var>HexToString</var> ~~method.~~		<li><var>HexToString</var> displays a question mark (<code>?</code>) in cases where a converted hex value has no displayable character representation.
	*The inverse of <var>~~HexToString~~</var> ~~is [[StringToHex (String function)\|StringToHex]]~~.		<li><var>HexToString</var> is available as of <var class="product">Sirius Mods</var> version 7.2.</ul>

	==Examples==		==Examples==
	*The following statement displays ~~''''~~Saint Marie~~''''~~:		<ol><li>The following statement displays <code>Saint Marie</code>:
	<p class="code">[[Intrinsic classes#printtext\|printText]] {'E2818995A340D481998985':hexToString}		<p class="code">[[Intrinsic classes#printtext\|printText]] {'E2818995A340D481998985':hexToString}
	</p>		</p>
	*The following statement displays ~~''''~~??~~'''~~' because no displayable characters exist for the specified hex values:		<li>The following statement displays <code>??</code>' because no displayable characters exist for the specified hex values:
	<p class="code">printText {'FFFE':hexToString(signed=true)}		<p class="code">printText {'FFFE':hexToString(signed=true)}
			</p>
			</ol>

	~~</p>~~
	==See also==		==See also==
			<ul><li>[[X (String function)\|X]] is a compile-time only equivalent of the <var>HexToString</var> method.
			<li>The inverse of <var>HexToString</var> is <var>[[StringToHex (String function)\|StringToHex]]</var>.</ul>
	{{Template:String:HexToString footer}}		{{Template:String:HexToString footer}}

Wiccan: 1 revision

2011-01-26T20:54:12Z

1 revision

← Older revision	Revision as of 20:54, 26 January 2011
(No difference)

Wiccan: 1 revision

2011-01-26T20:54:06Z

1 revision

← Older revision		Revision as of 20:54, 26 January 2011
Line 41:		Line 41:
	==See also==		==See also==
	{{Template:String:HexToString footer}}		{{Template:String:HexToString footer}}
	~~[[List of intrinsic String methods]]~~