$StrOr: Difference between revisions
Jump to navigation
Jump to search
m (→Syntax) |
(Automatically generated page update) |
||
| (13 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Bit-wise OR two strings</span> | <span class="pageSubtitle">Bit-wise OR two strings</span> | ||
<p class=" | <p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $StrOr function is the [[BitOrString (String function)]].</p> | ||
This function performs a bit-wise OR of two strings. | This function performs a bit-wise OR of two strings. | ||
The <var>$StrOr</var> function accepts three arguments and returns a string result that is the bit-wise 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>$StrOr</var> function accepts three arguments and returns a string result that is the bit-wise 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== | ==Syntax== | ||
<p class="syntax"><span class="term">%STR</span> = <span class="literal">$StrOr</span>(<span class="term">string1</span>, <span class="term">string2</span>, [<span class="term">pad</span>]) | <p class="syntax"><span class="term">%STR</span> = <span class="literal">$StrOr</span>(<span class="term">string1</span>, <span class="term">string2</span>, [<span class="term">pad</span>]) | ||
</p> | </p> | ||
< | ===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> | |||
<tr><th>string1</th> | |||
<td>An arbitrary string.</td></tr> | |||
< | <tr><th>string2</th> | ||
<td>Another arbitrary string.</td></tr> | |||
</ | |||
<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== | ||
<ol> | |||
<li>This code fragment would set <code>%junk</code> to <code>X'756333445566'</code>: | |||
<p class="code">%X = $X2C('112233445566') | |||
%Y = $X2C('654321') | |||
%junk = $StrOr(%X, %Y) | |||
</p> | </p> | ||
would set % | <li>These statements would set <code>%junk</code> to <code>X'DDEEFFCCDDEE'</code>: | ||
<p class="code">%X = $X2C('112233445566') | |||
%junk = $StrOr(%X, , $X2C('CC')) | |||
</p> | |||
<p class="code"> %X = $X2C('112233445566') | <li>This code fragment would set <code>%junk</code> to <code>X'1122FF44FF66'</code>: | ||
<p class="code">%X = $X2C('112233445566') | |||
%Y = $X2C('1122') | |||
%Z = $X2C('FF00') | |||
%junk = $StrOr(%X, %Y, %Z) | |||
</p> | </p> | ||
</ol> | |||
==Products authorizing {{PAGENAMEE}}== | ==Products authorizing {{PAGENAMEE}}== | ||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
<li>[[Sirius functions]]</li> | <li>[[List of $functions|Sirius functions]]</li> | ||
<li>[[Fast/Unload User Language Interface]]</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 Sockets]]</li> | ||
<li>[[Janus Web Server]]</li> | <li>[[Janus Web Server]]</li> | ||
<li> | <li>Japanese functions</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$StrOr]] | [[Category:$Functions|$StrOr]] | ||
Latest revision as of 23:28, 20 September 2018
Bit-wise OR two strings
Note: Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $StrOr function is the BitOrString (String function).
This function performs a bit-wise OR of two strings.
The $StrOr function accepts three arguments and returns a string result that is the bit-wise 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 = $StrOr(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
%junktoX'756333445566':%X = $X2C('112233445566') %Y = $X2C('654321') %junk = $StrOr(%X, %Y)
- These statements would set
%junktoX'DDEEFFCCDDEE':%X = $X2C('112233445566') %junk = $StrOr(%X, , $X2C('CC'))
- This code fragment would set
%junktoX'1122FF44FF66':%X = $X2C('112233445566') %Y = $X2C('1122') %Z = $X2C('FF00') %junk = $StrOr(%X, %Y, %Z)