Utf16ToUnicode (String function) - Revision history

JAL: minor cleanup

2016-04-13T19:35:37Z

minor cleanup

← Older revision		Revision as of 19:35, 13 April 2016
Line 8:		Line 8:
	<table>		<table>
	<tr><th>%unicode</th>		<tr><th>%unicode</th>
	<td>A Unicode string variable to receive the method object <var class="term">string</var> translated to <var>Unicode</var>. </td></tr>		<td>A <var>Unicode</var> string variable to receive the method object <var class="term">string</var> translated to <var>Unicode</var>. </td></tr>

	<tr><th>string</th>		<tr><th>string</th>
Line 14:		Line 14:

	<tr><th><var>AllowUntranslatable</var></th>		<tr><th><var>AllowUntranslatable</var></th>
	<td>This argument indicates whether this function will store values into the target Unicode string that cannot be translated to EBCDIC. This value defaults to <var>True</var>, which means that such values ~~would be~~ allowed. If this argument is set to <var>False</var>, a Unicode value not translatable to EBCDIC ~~would produce~~ a [[CharacterTranslationException class\|CharacterTranslationException exception]]. Unless there is a compelling reason to do otherwise, it is best to use the default value of <var>True</var>.</td></tr>		<td>This argument indicates whether this function will store values into the target <var>Unicode</var> string that cannot be translated to EBCDIC. This value defaults to <var>True</var>, which means that such values are allowed. If this argument is set to <var>False</var>, a Unicode value not translatable to EBCDIC produces a [[CharacterTranslationException class\|CharacterTranslationException exception]].
			<p>
			Unless there is a compelling reason to do otherwise, it is best to use the default value of <var>True</var>.</p></td></tr>

	<tr><th><var>BOM</var></th>		<tr><th><var>BOM</var></th>
	<td>This Byte Order Mark argument is <i><b>usable only by Rocket Software</b>. Contact Rocket Software if you think this argument might be of value to you.</i>		<td>This Byte Order Mark argument is <i><b>usable only by Rocket Software</b>. [[Contacting Rocket Software Technical Support\|Contact Rocket Software]] if you think this argument might be of value to you.</i>
	<p>		<p>
	<var>BOM</var> is a name required parameter with a value that is a <var>Utf16Bom</var> enumeration. </p></td></tr>		<var>BOM</var> is a name required parameter with a value that is a <var>Utf16Bom</var> enumeration. </p></td></tr>
Line 31:		Line 33:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>The input UTF-16 stream may contain a Byte Order Mark (U+FEFF).<ul><li>If one is present, that controls the conversion from UTF-16 to <var>Unicode</var>.<li> If a Byte Order Mark is not present, the input stream is considered to be a Big Endian stream, that is, it is the same as if the stream were preceded by the two bytes X'FE' and X'FF', in that order.</ul>		<li>The input UTF-16 stream may contain a Byte Order Mark (U+FEFF).<ul><li>If one is present, that controls the conversion from UTF-16 to <var>Unicode</var>.<li> If a Byte Order Mark is not present, the input stream is considered to be a Big Endian stream: that is, it is the same as if the stream were preceded by the two bytes X'FE' and X'FF', in that order.</ul>

	~~<li>The <var>Utf16ToUnicode</var> function is available as of <var class="product">Sirius Mods</var> Version 7.3.~~
	</ul>		</ul>

Line 48:		Line 48:
	==See also==		==See also==
	<ul>		<ul>
	<li>[[Unicode#UTF-8 and UTF-16\|UTF-8 and UTF-16]] has more information about UTF-16 conversions.		<li>[[Unicode#UTF-8 and UTF-16\|UTF-8 and UTF-16]] has more information about UTF-16 conversions. </li>

	<li>The <var>[[Utf8ToUnicode (String function)\|Utf8ToUnicode]]</var> method converts a UTF-8 byte stream to <var>Unicode</var>.		<li>The <var>[[Utf8ToUnicode (String function)\|Utf8ToUnicode]]</var> method converts a UTF-8 byte stream to <var>Unicode</var>. </li>
	</ul>		</ul>

	{{Template:String:Utf16ToUnicode footer}}		{{Template:String:Utf16ToUnicode footer}}

ELowell: /* Syntax terms */

2015-03-19T18:50:52Z

Syntax terms

← Older revision		Revision as of 18:50, 19 March 2015
Line 14:		Line 14:

	<tr><th><var>AllowUntranslatable</var></th>		<tr><th><var>AllowUntranslatable</var></th>
	<td>This argument is indicates whether this function will store values into the target ~~unicode~~ string that cannot be translated to EBCDIC. This value defaults to <var>True</var> which means that such values would be allowed. If this argument is set to <var>False</var> a ~~unicode~~ value not translatable to EBCDIC would produce a [[CharacterTranslationException class\|CharacterTranslationException exception]]. Unless there is a compelling reason to do otherwise it is best to use the default value of <var>True</var>.</td></tr>		<td>This argument indicates whether this function will store values into the target Unicode string that cannot be translated to EBCDIC. This value defaults to <var>True</var>, which means that such values would be allowed. If this argument is set to <var>False</var>, a Unicode value not translatable to EBCDIC would produce a [[CharacterTranslationException class\|CharacterTranslationException exception]]. Unless there is a compelling reason to do otherwise, it is best to use the default value of <var>True</var>.</td></tr>

	<tr><th><var>BOM</var></th>		<tr><th><var>BOM</var></th>
	<td>This Byte Order Mark argument is <i><b>usable only by Rocket Software</b>. Contact Rocket Software if you think this argument ~~may~~ be of value to you.</i>		<td>This Byte Order Mark argument is <i><b>usable only by Rocket Software</b>. Contact Rocket Software if you think this argument might be of value to you.</i>
	<p>		<p>
	<var>BOM</var> is a name required parameter with a value that is a <var>Utf16Bom</var> enumeration. </p></td></tr>		<var>BOM</var> is a name required parameter with a value that is a <var>Utf16Bom</var> enumeration. </p></td></tr>

Alex: /* Syntax terms */

2015-03-19T17:48:21Z

Syntax terms

← Older revision		Revision as of 17:48, 19 March 2015
Line 14:		Line 14:

	<tr><th><var>AllowUntranslatable</var></th>		<tr><th><var>AllowUntranslatable</var></th>
	<td>This argument is indicates whether this function will store values into the target unicode string that cannot be translated to EBCDIC. This value defaults to <var>True</var> which means that such values would be allowed. If this argument is set to <var>False</var> a unicode value not translatable to EBCDIC would produce a [[CharacterTranslationException class\|CharacterTranslationException exception]]. Unless there is a compelling reason to do otherwise it is best to use the default value of <var>True</var>.~~</p>~~</td></tr>		<td>This argument is indicates whether this function will store values into the target unicode string that cannot be translated to EBCDIC. This value defaults to <var>True</var> which means that such values would be allowed. If this argument is set to <var>False</var> a unicode value not translatable to EBCDIC would produce a [[CharacterTranslationException class\|CharacterTranslationException exception]]. Unless there is a compelling reason to do otherwise it is best to use the default value of <var>True</var>.</td></tr>

	<tr><th><var>BOM</var></th>		<tr><th><var>BOM</var></th>

Alex: /* Syntax terms */

2015-03-19T17:46:53Z

Syntax terms

← Older revision		Revision as of 17:46, 19 March 2015
Line 14:		Line 14:

	<tr><th><var>AllowUntranslatable</var></th>		<tr><th><var>AllowUntranslatable</var></th>
	<td>This argument is <i>~~<b>usable only by Rocket Software~~</b>. ~~[[Contacting Rocket Software Technical Support\|Contact Rocket Software]] if you think~~ this argument ~~may be of value~~ to ~~you.</i>~~		<td>This argument is indicates whether this function will store values into the target unicode string that cannot be translated to EBCDIC. This value defaults to <var>True</var> which means that such values would be allowed. If this argument is set to <var>False</var> a unicode value not translatable to EBCDIC would produce a [[CharacterTranslationException class\|CharacterTranslationException exception]]. Unless there is a compelling reason to do otherwise it is best to use the default value of <var>True</var>.</p></td></tr>
	~~<p>~~
	<var>~~AllowUntranslatable~~</var> is a [[~~Notation conventions for methods#Named arguments~~\|~~name required~~]] ~~parameter with~~ a value ~~that is a~~ <var>~~Boolean~~</var> ~~enumeration~~. </p></td></tr>

	<tr><th><var>BOM</var></th>		<tr><th><var>BOM</var></th>

JAL: /* Syntax terms */

2014-10-15T21:14:09Z

Syntax terms

← Older revision		Revision as of 21:14, 15 October 2014
Line 6:		Line 6:

	===Syntax terms===		===Syntax terms===
	<table ~~class="syntaxTable"~~>		<table>
	<tr><th>%unicode</th>		<tr><th>%unicode</th>
	<td>A Unicode string variable to receive the method object <var class="term">string</var> translated to <var>Unicode</var>. </td></tr>		<td>A Unicode string variable to receive the method object <var class="term">string</var> translated to <var>Unicode</var>. </td></tr>
Line 14:		Line 14:

	<tr><th><var>AllowUntranslatable</var></th>		<tr><th><var>AllowUntranslatable</var></th>
	<td>This argument is <i><b>usable only by Rocket Software</b>. [[Contacting Rocket Software Technical Support\|Contact Rocket Software]] if you think this argument may be of value to you.		<td>This argument is <i><b>usable only by Rocket Software</b>. [[Contacting Rocket Software Technical Support\|Contact Rocket Software]] if you think this argument may be of value to you.</i>
	<p>		<p>
	<var>AllowUntranslatable</var> is a [[Notation conventions for methods#Named arguments\|name required]] parameter with a value that is a <var>Boolean</var> enumeration. </p~~></i~~></td></tr>		<var>AllowUntranslatable</var> is a [[Notation conventions for methods#Named arguments\|name required]] parameter with a value that is a <var>Boolean</var> enumeration. </p></td></tr>

	<tr><th><var>BOM</var></th>		<tr><th><var>BOM</var></th>
Line 22:		Line 22:
	<p>		<p>
	<var>BOM</var> is a name required parameter with a value that is a <var>Utf16Bom</var> enumeration. </p></td></tr>		<var>BOM</var> is a name required parameter with a value that is a <var>Utf16Bom</var> enumeration. </p></td></tr>

	</table>		</table>

JAL at 18:21, 23 July 2014

2014-07-23T18:21:08Z

← Older revision		Revision as of 18:21, 23 July 2014
Line 4:		Line 4:
	==Syntax==		==Syntax==
	{{Template:String:Utf16ToUnicode syntax}}		{{Template:String:Utf16ToUnicode syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%unicode</th>		<tr><th>%unicode</th>
	<td>A Unicode string variable to receive the method object <var class="term">string</var> translated to <var>Unicode</var>. </td></tr>		<td>A Unicode string variable to receive the method object <var class="term">string</var> translated to <var>Unicode</var>. </td></tr>

	<tr><th>string</th>		<tr><th>string</th>
	<td>A string that is presumed to contain a UTF-16 byte stream.</td></tr>		<td>A string that is presumed to contain a UTF-16 byte stream.</td></tr>

	<tr><th><var>AllowUntranslatable</var></th>		<tr><th><var>AllowUntranslatable</var></th>
	<td>This argument is usable only by ~~Sirius~~ Software.</td></tr>		<td>This argument is <i><b>usable only by Rocket Software</b>. [[Contacting Rocket Software Technical Support\|Contact Rocket Software]] if you think this argument may be of value to you.
			<p>
			<var>AllowUntranslatable</var> is a [[Notation conventions for methods#Named arguments\|name required]] parameter with a value that is a <var>Boolean</var> enumeration. </p></i></td></tr>

	<tr><th><var>BOM</var></th>		<tr><th><var>BOM</var></th>
	<td>This argument is usable only by ~~Sirius~~ Software.</td></tr>		<td>This Byte Order Mark argument is <i><b>usable only by Rocket Software</b>. Contact Rocket Software if you think this argument may be of value to you.</i>
			<p>
			<var>BOM</var> is a name required parameter with a value that is a <var>Utf16Bom</var> enumeration. </p></td></tr>

	</table>		</table>

JAL at 16:29, 23 July 2014

2014-07-23T16:29:19Z

← Older revision		Revision as of 16:29, 23 July 2014
Line 43:		Line 43:
	==See also==		==See also==
	<ul>		<ul>
	<li>[[Unicode#UTF-~~8_and_UTF~~-16\|"UTF-8 and UTF-16"]] has more information about UTF-16 conversions.		<li>[[Unicode#UTF-8 and UTF-16\|UTF-8 and UTF-16]] has more information about UTF-16 conversions.

	<li>The <var>[[Utf8ToUnicode (String function)\|Utf8ToUnicode]]</var> method converts a UTF-8 byte stream to <var>Unicode</var>.		<li>The <var>[[Utf8ToUnicode (String function)\|Utf8ToUnicode]]</var> method converts a UTF-8 byte stream to <var>Unicode</var>.

JAL at 23:07, 5 November 2012

2012-11-05T23:07:59Z

← Older revision		Revision as of 23:07, 5 November 2012
Line 25:		Line 25:

	==Usage notes==		==Usage notes==
	<ul><li>The input UTF-16 stream may contain a Byte Order Mark (U+FEFF).<ul><li>If one is present, that controls the conversion from UTF-16 to <var>Unicode</var>.<li> If a Byte Order Mark is not present, the input stream is considered to be a Big Endian stream, that is, it is the same as if the stream were preceded by the two bytes X'FE' and X'FF', in that order.</ul>		<ul>
	<li>The <var>Utf16ToUnicode</var> function is available as of <var class="product">[[Sirius Mods~~\|Sirius Mods]]~~</var> Version 7.3.</ul>		<li>The input UTF-16 stream may contain a Byte Order Mark (U+FEFF).<ul><li>If one is present, that controls the conversion from UTF-16 to <var>Unicode</var>.<li> If a Byte Order Mark is not present, the input stream is considered to be a Big Endian stream, that is, it is the same as if the stream were preceded by the two bytes X'FE' and X'FF', in that order.</ul>

			<li>The <var>Utf16ToUnicode</var> function is available as of <var class="product">Sirius Mods</var> Version 7.3.
			</ul>

	==Examples==		==Examples==
	In the following fragment, <var>Utf16ToUnicode</var> converts a hexadecimal input to a single <var>Unicode</var> character.		In the following fragment, <var>Utf16ToUnicode</var> converts a hexadecimal input to a single <var>Unicode</var> character:
	<p class="code">%u unicode		<p class="code">%u unicode
	%u = '0032':[[X (String function)\|X]]:Utf16ToUnicode		%u = '0032':[[X (String function)\|X]]:Utf16ToUnicode
Line 39:		Line 42:

	==See also==		==See also==
	<ul><li>[[Unicode#UTF-8_and_UTF-16\|UTF-8 and UTF-16]] has more information about UTF-16 conversions.		<ul>
	<li>The [[Utf8ToUnicode (String function)\|Utf8ToUnicode]] method converts a UTF-8 byte stream to <var>Unicode</var>.</ul>		<li>[[Unicode#UTF-8_and_UTF-16\|"UTF-8 and UTF-16"]] has more information about UTF-16 conversions.

			<li>The <var>[[Utf8ToUnicode (String function)\|Utf8ToUnicode]]</var> method converts a UTF-8 byte stream to <var>Unicode</var>.
			</ul>

	{{Template:String:Utf16ToUnicode footer}}		{{Template:String:Utf16ToUnicode footer}}

JAL2: /* Syntax terms */

2011-11-22T00:28:41Z

Syntax terms

← Older revision		Revision as of 00:28, 22 November 2011
Line 7:		Line 7:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%unicode</th>		<tr><th>%unicode</th>
	<td>A string variable to receive the method object <var class="term">string</var> translated to <var>Unicode</var>. </td></tr>		<td>A Unicode string variable to receive the method object <var class="term">string</var> translated to <var>Unicode</var>. </td></tr>
	<tr><th>string</th>		<tr><th>string</th>
	<td>A string that is presumed to contain a UTF-16 byte stream.</td></tr>		<td>A string that is presumed to contain a UTF-16 byte stream.</td></tr>

Dme: /* Syntax terms */

2011-05-23T21:17:07Z

Syntax terms

← Older revision		Revision as of 21:17, 23 May 2011
Line 11:		Line 11:
	<td>A string that is presumed to contain a UTF-16 byte stream.</td></tr>		<td>A string that is presumed to contain a UTF-16 byte stream.</td></tr>
	<tr><th><var>AllowUntranslatable</var></th>		<tr><th><var>AllowUntranslatable</var></th>
	<td><var>~~AllowUntranslatable~~</var> is ~~an optional, but [[Methods#Named parameters\|name required]], parameter that is a [[Enumerations#Using_Boolean_enumerations\|"Boolean Enumeration"]] value that specifies ...~~. ~~[[??]] must fix this~~</td></tr>		<td>This argument is usable only by Sirius Software.</td></tr>
			<tr><th><var>BOM</var></th>
			<td>This argument is usable only by Sirius Software.</td></tr>

	</table>		</table>