UnicodeToUtf16 (Unicode function) - Revision history

JAL at 20:07, 6 November 2012

2012-11-06T20:07:45Z

← Older revision		Revision as of 20:07, 6 November 2012
Line 4:		Line 4:
	==Syntax==		==Syntax==
	{{Template:Unicode:UnicodeToUtf16 syntax}}		{{Template:Unicode:UnicodeToUtf16 syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>A <var>String</var> or <var>Longstring</var> variable to receive the method object string translated to a UTF-16 Big-Endian byte stream (that is, any <var>Unicode</var> point <code>U+wxyz</code> results in the pair of bytes <code>X'wx'</code> and <code>X'yz'</code>, in that order). </td></tr>		<td>A <var>String</var> or <var>Longstring</var> variable to receive the method object string translated to a UTF-16 Big-Endian byte stream (that is, any <var>Unicode</var> point <code>U+wxyz</code> results in the pair of bytes <code>X'wx'</code> and <code>X'yz'</code>, in that order). </td></tr>

	<tr><th>unicode</th>		<tr><th>unicode</th>
	<td>A <var>Unicode</var> string. </td></tr>		<td>A <var>Unicode</var> string. </td></tr>

	<tr><th><var>InsertBOM</var></th>		<tr><th><var>InsertBOM</var></th>
	<td>The optional ~~(<var>~~[[~~Methods~~#Named parameters\|~~NameRequired~~]]~~</var>)~~ <var>InsertBOM</var> argument is a <var>[[Enumerations#Using Boolean enumerations\|Boolean]]</var>: <ul> <li>If its value is <code>True</code>, the "Byte Order Mark" (U+FEFF) is inserted at the start of the output stream. <li>If its value is <code>False</code>, the default, no Byte Order Mark is inserted. </ul></td></tr>		<td>The optional, [[Notation conventions for methods#Named parameters\|name required]], <var>InsertBOM</var> argument is a <var>[[Enumerations#Using Boolean enumerations\|Boolean]]</var>:
			<ul>
			<li>If its value is <code>True</code>, the "Byte Order Mark" (U+FEFF) is inserted at the start of the output stream.
			<li>If its value is <code>False</code>, the default, no Byte Order Mark is inserted.
			</ul></td></tr>
	</table>		</table>

Line 22:		Line 29:

	==Usage notes==		==Usage notes==
	<ul><li><var>UnicodeToUtf16</var> is available as of <var class="product">[[Sirius Mods]]</var> Version 7.3.</ul>		<ul>
			<li><var>UnicodeToUtf16</var> is available as of <var class="product">Sirius Mods</var> Version 7.3.
			</ul>

	==Examples==		==Examples==
Line 36:		Line 45:

	==See also==		==See also==
	<ul><li>For more information about UTF-16 conversions, see [[Unicode#UTF-8 and UTF-16\|"Unicode: UTF-8 and UTF-16"]].		<ul>
			<li>For more information about UTF-16 conversions, see [[Unicode#UTF-8 and UTF-16\|"Unicode: UTF-8 and UTF-16"]].
	<li><var>[[UnicodeToUtf8 (Unicode function)\|UnicodeToUtf8]]</var> converts a <var>Unicode</var> string to UTF-8.		<li><var>[[UnicodeToUtf8 (Unicode function)\|UnicodeToUtf8]]</var> converts a <var>Unicode</var> string to UTF-8.
	<li><var>[[Utf16ToUnicode (String function)\|Utf16ToUnicode]]</var> converts a UTF-16 <var>Longstring</var> byte stream to <var>Unicode</var>.</ul>		<li><var>[[Utf16ToUnicode (String function)\|Utf16ToUnicode]]</var> converts a UTF-16 <var>Longstring</var> byte stream to <var>Unicode</var>.
			</ul>

	{{Template:Unicode:UnicodeToUtf16 footer}}		{{Template:Unicode:UnicodeToUtf16 footer}}

JAL: /* Examples */

2012-11-06T20:04:40Z

Examples

← Older revision		Revision as of 20:04, 6 November 2012
Line 25:		Line 25:

	==Examples==		==Examples==
	~~<ol><li>~~
	The following fragment shows a successful call of <var>UnicodeToUtf16</var>.		The following fragment shows a successful call of <var>UnicodeToUtf16</var>.
	<p class="code">%u unicode initial('&#x31;':[[U (String function)\|U]])		<p class="code">%u unicode initial('&#x31;':[[U (String function)\|U]])
Line 34:		Line 33:
	<p class="output">0031		<p class="output">0031
	FEFF0031		FEFF0031
	</p~~></ol~~>		</p>

	==See also==		==See also==

JALWiccan: 1 revision

2012-11-06T17:32:27Z

1 revision

← Older revision	Revision as of 17:32, 6 November 2012
(No difference)

JALWiccan: 1 revision

2012-11-06T17:32:25Z

1 revision

← Older revision		Revision as of 17:32, 6 November 2012
Line 27:		Line 27:
	<ol><li>		<ol><li>
	The following fragment shows a successful call of <var>UnicodeToUtf16</var>.		The following fragment shows a successful call of <var>UnicodeToUtf16</var>.
	<p class="code">%u unicode initial('&~~amp;amp;~~amp;#x31;':[[U (String function)\|U]])		<p class="code">%u unicode initial('&#x31;':[[U (String function)\|U]])
	print %u:unicodeToUtf16:[[StringToHex (String function)\|stringToHex]]		print %u:unicodeToUtf16:[[StringToHex (String function)\|stringToHex]]
	print %u:unicodeToUtf16(InsertBOM=True):stringToHex		print %u:unicodeToUtf16(InsertBOM=True):stringToHex

JALWiccan: 1 revision

2011-05-24T20:32:38Z

1 revision

← Older revision	Revision as of 20:32, 24 May 2011
(No difference)

JAL2: /* Syntax terms */

2011-05-24T20:32:37Z

Syntax terms

← Older revision		Revision as of 20:32, 24 May 2011
Line 11:		Line 11:
	<td>A <var>Unicode</var> string. </td></tr>		<td>A <var>Unicode</var> string. </td></tr>
	<tr><th><var>InsertBOM</var></th>		<tr><th><var>InsertBOM</var></th>
	<td>The optional (<var>[[Methods#Named parameters\|NameRequired]]</var>) <var>InsertBOM</var> argument is a <var>[[Boolean]]</var>: <ul> <li>If its value is <code>True</code>, the "Byte Order Mark" (U+FEFF) is inserted at the start of the output stream. <li>If its value is <code>False</code>, the default, no Byte Order Mark is inserted. </ul></td></tr>		<td>The optional (<var>[[Methods#Named parameters\|NameRequired]]</var>) <var>InsertBOM</var> argument is a <var>[[Enumerations#Using Boolean enumerations\|Boolean]]</var>: <ul> <li>If its value is <code>True</code>, the "Byte Order Mark" (U+FEFF) is inserted at the start of the output stream. <li>If its value is <code>False</code>, the default, no Byte Order Mark is inserted. </ul></td></tr>
	</table>		</table>

Line 27:		Line 27:
	<ol><li>		<ol><li>
	The following fragment shows a successful call of <var>UnicodeToUtf16</var>.		The following fragment shows a successful call of <var>UnicodeToUtf16</var>.
	<p class="code">%u unicode initial('&amp;#x31;':[[U (String function)\|U]])		<p class="code">%u unicode initial('&amp;amp;#x31;':[[U (String function)\|U]])
	print %u:unicodeToUtf16:[[StringToHex (String function)\|stringToHex]]		print %u:unicodeToUtf16:[[StringToHex (String function)\|stringToHex]]
	print %u:unicodeToUtf16(InsertBOM=True):stringToHex		print %u:unicodeToUtf16(InsertBOM=True):stringToHex

JAL2: /* Syntax terms */

2011-04-13T00:57:53Z

Syntax terms

← Older revision		Revision as of 00:57, 13 April 2011
Line 11:		Line 11:
	<td>A <var>Unicode</var> string. </td></tr>		<td>A <var>Unicode</var> string. </td></tr>
	<tr><th><var>InsertBOM</var></th>		<tr><th><var>InsertBOM</var></th>
	<td>The optional (<var>[[Methods#Named parameters\|NameRequired]]</var>) <var ~~class="term"~~>InsertBOM</var> argument is a <var>[[Boolean]]</var>: <ul> <li>If its value is <code>True</code>, the "Byte Order Mark" (U+FEFF) is inserted at the start of the output stream. <li>If its value is <code>False</code>, the default, no Byte Order Mark is inserted. </ul></td></tr>		<td>The optional (<var>[[Methods#Named parameters\|NameRequired]]</var>) <var>InsertBOM</var> argument is a <var>[[Boolean]]</var>: <ul> <li>If its value is <code>True</code>, the "Byte Order Mark" (U+FEFF) is inserted at the start of the output stream. <li>If its value is <code>False</code>, the default, no Byte Order Mark is inserted. </ul></td></tr>
	</table>		</table>

JALWiccan: 1 revision

2011-04-13T00:55:36Z

1 revision

← Older revision	Revision as of 00:55, 13 April 2011
(No difference)

Goff at 00:55, 13 April 2011

2011-04-13T00:55:35Z

← Older revision		Revision as of 00:55, 13 April 2011
Line 10:		Line 10:
	<tr><th>unicode</th>		<tr><th>unicode</th>
	<td>A <var>Unicode</var> string. </td></tr>		<td>A <var>Unicode</var> string. </td></tr>
	<tr><th>InsertBOM</th>		<tr><th><var>InsertBOM</var></th>
	<td>The optional (<var>[[Methods#Named parameters\|NameRequired]]</var>) <var class="term">InsertBOM</var> argument is a <var>[[Boolean]]</var>: <ul> <li>If its value is <code>True</code>, the "Byte Order Mark" (U+FEFF) is inserted at the start of the output stream. <li>If its value is <code>False</code>, the default, no Byte Order Mark is inserted. </ul></td></tr>		<td>The optional (<var>[[Methods#Named parameters\|NameRequired]]</var>) <var class="term">InsertBOM</var> argument is a <var>[[Boolean]]</var>: <ul> <li>If its value is <code>True</code>, the "Byte Order Mark" (U+FEFF) is inserted at the start of the output stream. <li>If its value is <code>False</code>, the default, no Byte Order Mark is inserted. </ul></td></tr>
	</table>		</table>
Line 27:		Line 27:
	<ol><li>		<ol><li>
	The following fragment shows a successful call of <var>UnicodeToUtf16</var>.		The following fragment shows a successful call of <var>UnicodeToUtf16</var>.
	<p class="code">%u unicode initial('&#x31;':[[U (String function)\|U]])		<p class="code">%u unicode initial('&amp;#x31;':[[U (String function)\|U]])
	print %u:unicodeToUtf16:[[StringToHex (String function)\|stringToHex]]		print %u:unicodeToUtf16:[[StringToHex (String function)\|stringToHex]]
	print %u:unicodeToUtf16(InsertBOM=True):stringToHex		print %u:unicodeToUtf16(InsertBOM=True):stringToHex

Goff at 00:52, 14 March 2011

2011-03-14T00:52:12Z

← Older revision		Revision as of 00:52, 14 March 2011
Line 25:		Line 25:

	==Examples==		==Examples==
			<ol><li>
	The following fragment shows a successful call of <var>UnicodeToUtf16</var>.		The following fragment shows a successful call of <var>UnicodeToUtf16</var>.
	<p class="code">%u unicode initial('&#x31;':[[U (String function)\|U]])		<p class="code">%u unicode initial('&#x31;':[[U (String function)\|U]])
Line 34:		Line 34:
	<p class="output">0031		<p class="output">0031
	FEFF0031		FEFF0031
	</p>		</p></ol>

	==See also==		==See also==