$StrXor: Difference between revisions

Latest revision as of 23:28, 20 September 2018

Bit-wise exclusive OR two strings

Note: Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $StrXor function is BitXorString.

This function performs a bit-wise exclusive OR of two strings.

The $StrXor function accepts three arguments and returns a string result that is the bit-wise exclusive OR of the first two arguments, the shorter being padded with as many copies of the third argument as are required to make the string lengths equal.

Syntax

%STR = $StrXor(string1, string2, [pad])

Syntax terms

%str	The bit-wise AND of `string1` and `string2`.
string1	An arbitrary string.
string2	Another arbitrary string.
pad	An arbitrary string that is appended to the shorter of the first two strings and replicated as many times as required to make the strings of equal length. If this value is not specified or is null, it defaults to a single null byte (X'00').

Examples

This code fragment would set %junk to X'746112445566':
%X = $X2C('112233445566') %Y = $X2C('654321') %junk = $StrXor(%X, %Y)
These statements would set %junk to X'DDEEFF8899AA':
%X = $X2C('112233445566') %junk = $StrXor(%X, , $X2C('CC'))
This code fragment would set %junk to X'0000CC44AA66':
%X = $X2C('112233445566') %Y = $X2C('1122') %Z = $X2C('FF00') %junk = $StrXor(%X, %Y, %Z)

Products authorizing $StrXor

@@ Line 2: / Line 2: @@
 <span class="pageSubtitle">Bit-wise exclusive OR two strings</span>
-<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $StrXor function is the [[BitXorString (String function)]].</p>
+<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $StrXor function is <var>[[BitXorString (String function)|BitXorString]]</var>.</p>
 This function performs a bit-wise exclusive OR of two strings.
-The $StrXor function accepts three arguments and returns a string result that is the bit-wise exclusive OR of the first two arguments, the shorter being padded with as many copies of the third argument as are required to make the string lengths equal.
+The <var>$StrXor</var> function accepts three arguments and returns a string result that is the bit-wise exclusive OR of the first two arguments, the shorter being padded with as many copies of the third argument as are required to make the string lengths equal.
-The first argument is an arbitrary string.
+==Syntax==
+<p class="syntax"><span class="term">%STR</span> = <span class="literal">$StrXor</span>(<span class="term">string1</span>, <span class="term">string2</span>, [<span class="term">pad</span>])
+</p>
-The second argument is another arbitrary string.
+===Syntax terms===
+<table>
+<tr><th>%str</th>
+<td>The bit-wise AND of <var class="term">string1</var> and <var class="term">string2</var>.</td></tr>
-The third argument is another arbitrary string that is appended to the shorter of the first two strings and replicated as many times as required to make the strings of equal length. If this value is not specified or is null it defaults to a single null byte (X'00').
+<tr><th>string1</th>
+<td>An arbitrary string.</td></tr>
-==Syntax==
+<tr><th>string2</th>
-<p class="syntax"><section begin="syntax" /> %STR = $StrXor(string1, string2, pad)
+<td>Another arbitrary string.</td></tr>
-<section end="syntax" /></p>
-<p class="caption">$StrXor Function
-</p>
-<p class="caption">%STR is the bit-wise exclusive OR of '''string1''' and '''string2'''.</p>
-For example
+<tr><th>pad</th>
+<td>An arbitrary string that is appended to the shorter of the first two strings and replicated as many times as required to make the strings of equal length. If this value is not specified or is null, it defaults to a single null byte (X'00').
+</td></tr>
+</table>
-<p class="code"> %X = $X2C('112233445566')
+==Examples==
- %Y = $X2C('654321')
+<ol>
- %JUNK = $StrXor(%X, %Y)
+<li>This code fragment would set <code>%junk</code> to <code>X'746112445566'</code>:
+<p class="code">%X = $X2C('112233445566')
+%Y = $X2C('654321')
+%junk = $StrXor(%X, %Y)
 </p>
-would set %JUNK to X'746112445566' and
+<li>These statements would set <code>%junk</code> to <code>X'DDEEFF8899AA'</code>:
+<p class="code">%X = $X2C('112233445566')
-<p class="code"> %X = $X2C('112233445566')
+%junk = $StrXor(%X, , $X2C('CC'))
- %JUNK = $StrXor(%X, , $X2C('CC'))
 </p>
-would set %JUNK to X'DDEEFF8899AA' and
+<li>This code fragment would set <code>%junk</code> to <code>X'0000CC44AA66'</code>:
+<p class="code">%X = $X2C('112233445566')
-<p class="code"> %X = $X2C('112233445566')
+%Y = $X2C('1122')
- %Y = $X2C('1122')
+%Z = $X2C('FF00')
- %Z = $X2C('FF00')
+%junk = $StrXor(%X, %Y, %Z)
- %JUNK = $StrXor(%X, %Y, %Z)
 </p>
+</ol>
-would set %JUNK to X'0000CC44AA66'.
+==Products authorizing {{PAGENAMEE}}==
-<var>$StrXor</var> is only available in <var class="product">[[Sirius Mods]]</var> Version 6.2 and later.
 <ul class="smallAndTightList">
-<li>[[Sirius functions]]</li>
+<li>[[List of $functions|Sirius functions]]</li>
 <li>[[Fast/Unload User Language Interface]]</li>
-<li>[[Janus Open Client]]</li>
+<li>[[Media:JoclrNew.pdf|Janus Open Client]]</li>
-<li>[[Janus Open Server]]</li>
+<li>[[Media:JosrvrNew.pdf|Janus Open Server]]</li>
 <li>[[Janus Sockets]]</li>
 <li>[[Janus Web Server]]</li>
-<li>[[Japanese functions]]</li>
+<li>Japanese functions</li>
-<li>[[Sir2000 Field Migration Facility]]</li>
+<li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li>
 </ul>
-<p class="caption">Products authorizing $StrXor
-</p>
 [[Category:$Functions|$StrXor]]